diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/openapi/components.yml | 59 | ||||
| -rw-r--r-- | docs/openapi/openapi.yml | 44 |
2 files changed, 103 insertions, 0 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml new file mode 100644 index 00000000..bc3a63a0 --- /dev/null +++ b/docs/openapi/components.yml @@ -0,0 +1,59 @@ +components: + schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + message: + type: string + details: + type: string + + responses: + NotFound: + description: The specified resource was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Unauthorized: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + BadRequest: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Ok: + description: OK + content: + application/json: + schema: + type: object + Created: + description: Created + content: + text/plain: + schema: + type: string + NoContent: + description: No Content + content: {} diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml new file mode 100644 index 00000000..0fe9d78f --- /dev/null +++ b/docs/openapi/openapi.yml @@ -0,0 +1,44 @@ +# ============LICENSE_START======================================================= +# Modification (C) 2021 Nordix Foundation +# ================================================================================ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# ============LICENSE_END========================================================= + +openapi: 3.0.1 +info: + title: NCMP DMI Plugin + description: Adds Data Model Inventory Registry capability for ONAP + version: "1.0.0" +servers: + - url: //localhost:8088/ +tags: + - name: dmi-rest + description: DMI Rest +paths: + /v1/helloworld: + get: + description: Hello World + tags: + - dmi-plugin + summary: Hello World + operationId: helloWorld + responses: + '200': + $ref: 'components.yml#/components/responses/Ok' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden'
\ No newline at end of file |