diff options
| author |   DylanB95EST <dylan.byrne@est.tech> | 2022-01-27 17:12:52 +0000 |
|---|---|---|
| committer | Dylan Byrne <dylan.byrne@est.tech> | 2022-03-01 16:17:16 +0000 |
| commit | e557338803286d8aaa0f877aa25d52d18735f309 (patch) | |
| tree | 059b68301b3e6c34d8bb68a8cb7dadf6bed45a06 /docs/api/swagger/ncmp/openapi-inventory.yaml | |
| parent | 03459a08895ecc7e481fc5ec34779556268992f1 (diff) | |
Create Endpoint For Get Cm Handles By Name
Create endpoint and implement logic for
get cm handle details by cm handle name
Issue-ID: CPS-817
Change-Id: I83bd2da9219d13fac715a08b19108028ca6f6751
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Diffstat (limited to 'docs/api/swagger/ncmp/openapi-inventory.yaml')
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 34a087b85c..154a4411da 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -53,6 +53,16 @@ paths: status: 403 message: Forbidden error message details: Forbidden error details + "500": + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred components: schemas: RestDmiPluginRegistration: @@ -61,26 +71,39 @@ components: dmiPlugin: type: string example: my-dmi-plugin + default: "" dmiDataPlugin: type: string example: my-dmi-data-plugin + default: "" dmiModelPlugin: type: string example: my-dmi-model-plugin + default: "" createdCmHandles: type: array items: - $ref: '#/components/schemas/RestCmHandle' + $ref: '#/components/schemas/RestInputCmHandle' updatedCmHandles: type: array + example: + cmHandle: my-cm-handle + cmHandleProperties: + add-my-property: add-property + update-my-property: updated-property + delete-my-property: ~ + publicCmHandleProperties: + add-my-property: add-property + update-my-property: updated-property + delete-my-property: ~ items: - $ref: '#/components/schemas/RestCmHandle' + $ref: '#/components/schemas/RestInputCmHandle' removedCmHandles: type: array items: type: string example: "[\"my-cm-handle1\",\"my-cm-handle2\",\"my-cm-handle3\"]" - RestCmHandle: + RestInputCmHandle: required: - cmHandle type: object |