X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-rest%2Fdocs%2Fopenapi%2Fcomponents.yaml;h=fd02b6e564470f8d43dd32368f67a236a5b346b1;hb=d042fcdae75be100f840b6313e078eab278d87ef;hp=719282b3e7c211b7ee62dec03f9b235da16ec176;hpb=d9104d8b03dff4ccc602c230e02fd9bcfb603b69;p=cps.git diff --git a/cps-ncmp-rest/docs/openapi/components.yaml b/cps-ncmp-rest/docs/openapi/components.yaml index 719282b3e..fd02b6e56 100644 --- a/cps-ncmp-rest/docs/openapi/components.yaml +++ b/cps-ncmp-rest/docs/openapi/components.yaml @@ -1,5 +1,5 @@ # ============LICENSE_START======================================================= -# Copyright (C) 2021 Nordix Foundation +# Copyright (C) 2021-2022 Nordix Foundation # Modifications Copyright (C) 2021 Pantheon.tech # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); @@ -38,19 +38,31 @@ 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' - example: [my-cm-handle1, my-cm-handle2, my-cm-handle3] 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' removedCmHandles: @@ -68,12 +80,14 @@ components: type: string example: my-cm-handle cmHandleProperties: - $ref: '#/components/schemas/RestCmHandleAdditionalProperties' - RestCmHandleAdditionalProperties: + $ref: '#/components/schemas/RestCmHandleProperties' + publicCmHandleProperties: + $ref: '#/components/schemas/RestCmHandleProperties' + RestCmHandleProperties: type: object additionalProperties: type: string - example: my-additional-property + example: my-property Conditions: type: object @@ -121,6 +135,17 @@ components: type: string example: my-cm-handle-id + ModuleReference: + type: object + title: Module reference details + properties: + moduleName: + type: string + example: my-module-name + revision: + type: string + example: my-module-revision + examples: dataSampleRequest: summary: Sample request @@ -134,7 +159,6 @@ components: books: - authors: - Iain M. Banks - - authors: - Ursula K. Le Guin - code: '02' name: kids @@ -142,6 +166,50 @@ components: - authors: - Philip Pullman + dataSamplePatchRequest: + summary: Sample patch request + description: Sample patch request body + value: + ietf-restconf:yang-patch: + patch-id: patch-1 + edit: + - edit-id: edit1 + operation: merge + target: / + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: '01' + name: Science + books: + - authors: + - Author1 + - Author2 + - code: '02' + name: Arts + books: + - authors: + - Author3 + - edit-id: edit2 + operation: merge + target: / + value: + test:bookstore: + bookstore-name: Novels + categories: + - code: '03' + name: History + books: + - authors: + - Iain M. Banks + - Ursula K. Le Guin + - code: '04' + name: Fiction + books: + - authors: + - Philip Pullman + dataSampleResponse: summary: Sample response description: Sample response for selecting 'sample 1'. @@ -150,14 +218,15 @@ components: categories: - code: '01' books: - - {} - - {} + - authors: + - Iain M. Banks + - Ursula K. Le Guin name: SciFi - code: '02' books: - - {} + - authors: + - Philip Pullman name: kids - bookstore-name: Chapters parameters: cmHandleInPath: @@ -326,3 +395,13 @@ components: NoContent: description: No Content content: {} + InternalServerError: + description: Internal Server Error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorMessage" + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred