Adding MDMS v2 contract #25
Conversation
WalkthroughThe update introduces a new OpenAPI specification for the Master Data Management Service (MDMS), enhancing its configurability and user-friendliness with features like schema creation, data manipulation, and advanced search capabilities. Changes
Possibly related issues
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional comments not posted (5)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| post: | ||
| tags: | ||
| - MDMS-Schema | ||
| summary: Get list of masters for a particular module and tenantId. | ||
| description: Get list of masters for a perticulare module and tenantId. | ||
| requestBody: | ||
| description: Details of module and master which need to be search using MDMS | ||
| . | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: '#/components/schemas/SchemaDefSearchRequest' | ||
| required: true | ||
| responses: | ||
| 200: | ||
| description: Schema Definition searched sucessfully. | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: '#/components/schemas/SchemaDefinitionResponse' | ||
| 400: | ||
| description: Invalid input. | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' |
There was a problem hiding this comment.
The summary and description for the /egov-mdms-service/schema/v1/_search endpoint contain a typo: "perticulare" should be "particular". Correcting this will improve the professionalism of the documentation.
- Get list of masters for a perticulare module and tenantId.
+ Get list of masters for a particular module and tenantId.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| post: | |
| tags: | |
| - MDMS-Schema | |
| summary: Get list of masters for a particular module and tenantId. | |
| description: Get list of masters for a perticulare module and tenantId. | |
| requestBody: | |
| description: Details of module and master which need to be search using MDMS | |
| . | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/SchemaDefSearchRequest' | |
| required: true | |
| responses: | |
| 200: | |
| description: Schema Definition searched sucessfully. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/SchemaDefinitionResponse' | |
| 400: | |
| description: Invalid input. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' | |
| post: | |
| tags: | |
| - MDMS-Schema | |
| summary: Get list of masters for a particular module and tenantId. | |
| description: Get list of masters for a particular module and tenantId. | |
| requestBody: | |
| description: Details of module and master which need to be search using MDMS | |
| . | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/SchemaDefSearchRequest' | |
| required: true | |
| responses: | |
| description: Schema Definition searched sucessfully. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/SchemaDefinitionResponse' | |
| description: Invalid input. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' |
| /egov-mdms-service/v2/_update/{schemaCode}: | ||
| post: | ||
| tags: | ||
| - MDMS | ||
| summary: Get list of masters for a particular module and tenantId. | ||
| description: Get list of masters for a perticulare module and tenantId. | ||
| parameters: | ||
| - in: path | ||
| name: schemaCode | ||
| schema: | ||
| type: string | ||
| required: true | ||
| description: Unique schema code from schema master | ||
|
|
||
| requestBody: | ||
| description: Details of module and master which need to be search using MDMS | ||
| . | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: '#/components/schemas/MdmsRequest' | ||
| required: true | ||
| responses: | ||
| 200: | ||
| description: Data updated sucessfully. | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: '#/components/schemas/MdmsResponseV2' | ||
| 400: | ||
| description: Invalid input. | ||
| content: | ||
| '*/*': | ||
| schema: | ||
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' |
There was a problem hiding this comment.
The description for the /egov-mdms-service/v2/_update/{schemaCode} endpoint is duplicated from a search endpoint. This should be updated to accurately reflect the update functionality.
- Get list of masters for a perticulare module and tenantId.
+ Update master data for a given schemaCode and tenantId.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| /egov-mdms-service/v2/_update/{schemaCode}: | |
| post: | |
| tags: | |
| - MDMS | |
| summary: Get list of masters for a particular module and tenantId. | |
| description: Get list of masters for a perticulare module and tenantId. | |
| parameters: | |
| - in: path | |
| name: schemaCode | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique schema code from schema master | |
| requestBody: | |
| description: Details of module and master which need to be search using MDMS | |
| . | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/MdmsRequest' | |
| required: true | |
| responses: | |
| 200: | |
| description: Data updated sucessfully. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/MdmsResponseV2' | |
| 400: | |
| description: Invalid input. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' | |
| /egov-mdms-service/v2/_update/{schemaCode}: | |
| post: | |
| tags: | |
| - MDMS | |
| summary: Get list of masters for a particular module and tenantId. | |
| description: Update master data for a given schemaCode and tenantId. | |
| parameters: | |
| - in: path | |
| name: schemaCode | |
| schema: | |
| type: string | |
| required: true | |
| description: Unique schema code from schema master | |
| requestBody: | |
| description: Details of module and master which need to be search using MDMS | |
| . | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/MdmsRequest' | |
| required: true | |
| responses: | |
| description: Data updated sucessfully. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: '#/components/schemas/MdmsResponseV2' | |
| description: Invalid input. | |
| content: | |
| '*/*': | |
| schema: | |
| $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-Specs/service-contracts/Common%20Services/common-contract.yaml#/components/schemas/ErrorRes' |
| type: object | ||
| properties: | ||
| action: | ||
| type: string | ||
| description: 'Action of the workflow to be performned on the request' | ||
| comment: | ||
| type: string | ||
| description: 'comment for the workflow action to be performed' | ||
| assignees: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: ' uuid of the users in the system to assign workflow to the specific user intead of a all the users with the gien role.' | ||
|
|
||
| required: [ action ] |
There was a problem hiding this comment.
The Workflow schema is missing a description for the action property. Adding a description can provide better clarity to API consumers on how to use this property.
+ description: 'Specify the action to be performed as part of the workflow'Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| type: object | |
| properties: | |
| action: | |
| type: string | |
| description: 'Action of the workflow to be performned on the request' | |
| comment: | |
| type: string | |
| description: 'comment for the workflow action to be performed' | |
| assignees: | |
| type: array | |
| items: | |
| type: string | |
| description: ' uuid of the users in the system to assign workflow to the specific user intead of a all the users with the gien role.' | |
| required: [ action ] | |
| type: object | |
| properties: | |
| action: | |
| type: string | |
| description: 'Specify the action to be performed as part of the workflow' | |
| comment: | |
| type: string | |
| description: 'comment for the workflow action to be performed' | |
| assignees: | |
| type: array | |
| items: | |
| type: string | |
| description: ' uuid of the users in the system to assign workflow to the specific user intead of a all the users with the gien role.' | |
| required: [ action ] |
Summary by CodeRabbit