...
| Issue | Notes | Decision | |
|---|---|---|---|
| 1 | dataaccepttype Do we need to consider this parameter in our NCMP internal Java interface? | The controller should accept/reject dataaccepttype. From the client application | The Controller will validate and set the Default as necessary kieran mccarthy Sourabh Sourabh Kolawole Adebisi-Adeolokun Toine Siebelink |
| 2 | datacontenttype Do we need to consider this parameter in our NCMP internal Java interface? | NCMP should maintain the content type as received and not modify datacontenttype. | NCMP should maintain what content type as received and not modify kieran mccarthy Sourabh Sourabh Kolawole Adebisi-Adeolokun Toine Siebelink |
| 3 |
| kieran mccarthy & Rafael to come back with a 'definition' and 'example | Kolawole Adebisi-Adeolokun to follow up with stakeholders on decision by 19/03/2024 |
| 4 | The study mentions ' | kieran mccarthy & Rafael to come back with a 'definition' and 'example | Read and Write data jobs are 2 deff. objects. Kolawole Adebisi-Adeolokun to follow up with stakeholders on decision by 19/03/2024 |
| 5 | Combine all java api parameters into 1 parameter object? | There is a limit (sonar quality check) of 7 parameter max for a method | Team |
| 6 | Confirm that validation is the responsibility of the REST? | Yes, the rest controller will do input validation. via email 26/03/2024 Csaba Kocsis | |
| 7 | Is Status likely to change in the future? Considering using string for flexibility. | Java interfaces shall be 'strings' Csaba Kocsis | |
| 8 | Is ScopeType likely to change in the future? Don't want to use an enum if change is likely | Java interfaces shall be 'strings Csaba Kocsis Kolawole Adebisi-Adeolokun | |
| 9 | Can one request contain both read and write operations? | Writes and reads will not mix. But different writes operations can mix, like update or create. via email 26/03/2024 Csaba Kocsis | |
| 10 | Was there a decision made on whether write requests were using kafka or is there any discussion ongoing? | Csaba Kocsis to update | |
| 11 | name of privateProperties (CMHandle private properties for the alternateID in the path.) | Can keep this var name as "cmHandleProperties" for consistency? | Agreed to use "cmHandleProperties" Csaba Kocsis Kolawole Adebisi-Adeolokun |
Data Structures
...
| Name | Description | Type | Mandatory |
|---|---|---|---|
| id | Identifier of the resource object | String | N |
| attributes | Attributes object whose members are the class attributes and values. The object contains key/value map where:
| Object | N |
ActionParameters
| Name | Description | Type | Mandatory |
|---|---|---|---|
| input | The input of the action. Key value pairs. | Object | N |
Response
Name | Description | Type | Mandatory |
jobId | The id of the data job | string | Y |
status | The status of the jobid | enum: [ NOT_STARTED, RUNNING, FINSHED, FAILED, PARTIALLY_FAILED, CANCELLING, CANCELLED ] | Y |
statusuri | Status uri for the jobid. Example: {apiRoot}/ranoam/cm/v1/dataJob/{jobId} | uri | Y |
resultsuri | Result uri for the jobid. Example: {apiRoot}/s3-bucket/{bucketId} | uri | Y |
...
READ
Status Code: 200 - Ok
| Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
resulturi | internal ncmp topic name | response body | String | Y |
Examples from DCM Study
DataJob Read request (rAPP -> DCM)
...
| Priority | Component | Description | JIRA | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | NCMP | Create implementation proposal for NCMP to provide support for Data jobs qualifier during registration |
| ||||||||||||||||||||||||||||||
| 2 | NCMP | NCMP to provide support for data producer identifier during registration |
| ||||||||||||||||||||||||||||||
| 3 | NCMP | Support of Datajobs qualifier during registration |
| ||||||||||||||||||||||||||||||
| 4 | NCMP | Modify the get cmHandle api to return dataProducerIdentifier, moduleSetTag, and alternateId |
| ||||||||||||||||||||||||||||||
| 5 | NCMP | Modify lcm events to include dataProducerIdentifier and moduleSetTag |
| ||||||||||||||||||||||||||||||
| 6 | NCMP | Create implementation proposal for NCMP to provide Java interface that can support Data jobs request |
| 7 | NCMP | Define a java based datastructure for DataJob |
| ||||||||||||||||||||||||||
| 7 | DMI | ||||||||||||||||||||||||||||||||
| 8 | NCMPHandle | Datajob request in java interfaceDefine a java based datastructure for DataJob |
| ||||||||||||||||||||||||||||||
| 9 | NCMP | Handle async datajob response Datajob request in java interface |
| ||||||||||||||||||||||||||||||
| 10 | DMI | NCMP | Handle async datajob response in java interfaceDefine DMI REST interface for Datajobs |
| |||||||||||||||||||||||||||||
| 11 | Define DMI REST interface for Datajobs | ||||||||||||||||||||||||||||||||
| 12 | DMI | Define a java based datastructure dmi request for dmi endpoint |
| ||||||||||||||||||||||||||||||
| 1213 | DMI | Response schema for DMI dataJob response |
| ||||||||||||||||||||||||||||||
| 1314 | NCMP | Forward dataJob response from DMI to client topic in header as destination |
| ||||||||||||||||||||||||||||||
| 1415 | DMI | Stub should be modified to use generated code from OpenAPI |
| ||||||||||||||||||||||||||||||
| 1516 | E2E demo for internal team and stakeholder |
|
...