diff options
| author |   niamhcore <niamh.core@est.tech> | 2021-10-06 09:49:12 +0100 |
|---|---|---|
| committer | niamhcore <niamh.core@est.tech> | 2021-10-07 11:51:40 +0100 |
| commit | acc0f8b83a320b979cb5db23906f4ef3baf5f42c (patch) | |
| tree | 581a83acb0129de9f061bc0b4fce0ecef83f50c1 /docs | |
| parent | f0acf5b1a4dd4bb774a81a7a75c48aeb81169fde (diff) | |
Updating get module schema request body
Issue-ID: CPS-706
Signed-off-by: niamhcore <niamh.core@est.tech>
Change-Id: I92d241c4ccde77aaaf8aa5a3903437016edf65d0
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/openapi/components.yml | 29 | ||||
| -rw-r--r-- | docs/openapi/openapi.yml | 6 |
2 files changed, 22 insertions, 13 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml index a03cb1f8..30e5987f 100644 --- a/docs/openapi/components.yml +++ b/docs/openapi/components.yml @@ -19,14 +19,15 @@ components: items: type: string - DmiModuleReadRequestBody: + ModuleReferencesRequest: + type: object + properties: + cmHandleProperties: + $ref: '#/components/schemas/cmHandleProperties' + + ModuleResourcesReadRequest: type: object properties: - operation: - type: string - enum: [read] - dataType: - type: string data: type: object properties: @@ -36,9 +37,9 @@ components: type: object properties: name: - type: string + $ref: '#/components/schemas/name' revision: - type: string + $ref: '#/components/schemas/revision' cmHandleProperties: $ref: '#/components/schemas/cmHandleProperties' @@ -53,7 +54,7 @@ components: moduleName: type: string revision: - type: string + $ref: '#/components/schemas/revision' namespace: type: string @@ -70,7 +71,7 @@ components: moduleName: type: string revision: - type: string + $ref: '#/components/schemas/revision' DataAccessReadRequest: type: object @@ -100,6 +101,14 @@ components: type: string example: {"prop1":"value1","prop2":"value2"} + name: + type: string + example: someName + + revision: + type: string + example: someRevision + responses: NotFound: description: The specified resource was not found diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml index 66f2e6b1..83c05abb 100644 --- a/docs/openapi/openapi.yml +++ b/docs/openapi/openapi.yml @@ -37,7 +37,7 @@ paths: - dmi-plugin summary: Get all modules for cm handle description: Get all modules for given cm handle - operationId: getModulesForCmHandle + operationId: getModuleReferences parameters: - name: cmHandle in: path @@ -50,7 +50,7 @@ paths: content: application/json: schema: - $ref: 'components.yml#/components/schemas/DataAccessReadRequest' + $ref: 'components.yml#/components/schemas/ModuleReferencesRequest' responses: '200': description: OK @@ -113,7 +113,7 @@ paths: content: application/json: schema: - $ref: 'components.yml#/components/schemas/DmiModuleReadRequestBody' + $ref: 'components.yml#/components/schemas/ModuleResourcesReadRequest' responses: '200': description: OK |