From 4a978d3c66da16bc96b54cba807138fc9b0c79fa Mon Sep 17 00:00:00 2001 From: mpriyank Date: Thu, 29 Feb 2024 14:39:00 +0000 Subject: Release notes added for 3.4.6 - added the release notes and openapi documentation Issue-ID: CPS-2135 Change-Id: Ib224353ca5a529b6788ecb67c6432b806acdf557 Signed-off-by: mpriyank --- docs/api/swagger/ncmp/openapi-inventory.yaml | 40 ------ docs/api/swagger/ncmp/openapi.yaml | 203 ++++++--------------------- 2 files changed, 43 insertions(+), 200 deletions(-) (limited to 'docs/api/swagger/ncmp') diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 53f51f3f8..ff9f4ba68 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -32,16 +32,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -115,16 +105,6 @@ paths: type: string type: array description: OK - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -169,16 +149,6 @@ paths: type: string type: array description: OK - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -226,16 +196,6 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - Unauthorized: - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized Forbidden: content: application/json: diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index a1cc5d9ba..9203b6d4c 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -56,6 +56,12 @@ paths: default: application/json example: application/yang-data+json type: string + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string responses: "204": content: {} @@ -70,16 +76,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -199,6 +195,12 @@ paths: schema: default: false type: boolean + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string responses: "200": content: @@ -220,16 +222,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -312,6 +304,12 @@ paths: default: application/json example: application/yang-data+json type: string + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string requestBody: content: '*/*': @@ -339,16 +337,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -430,6 +418,12 @@ paths: default: application/json example: application/yang-data+json type: string + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string requestBody: content: application/json: @@ -461,16 +455,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -553,6 +537,12 @@ paths: default: application/json example: application/yang-data+json type: string + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string requestBody: content: application/json: @@ -587,16 +577,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -649,6 +629,12 @@ paths: required: true schema: type: string + - description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string requestBody: content: application/json: @@ -672,16 +658,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -806,16 +782,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -883,16 +849,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -954,16 +910,6 @@ paths: $ref: '#/components/schemas/RestModuleDefinition' type: array description: OK - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1041,16 +987,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1104,16 +1040,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "404": content: application/json: @@ -1167,16 +1093,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "404": content: application/json: @@ -1254,16 +1170,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1327,16 +1233,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "404": content: application/json: @@ -1399,16 +1295,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1645,6 +1531,13 @@ components: schema: default: false type: boolean + authorizationParamInHeader: + description: Authorization parameter for request. + in: header + name: Authorization + required: false + schema: + type: string contentParamInHeader: description: "Content parameter for request, if content parameter is null, default\ \ value is application/json." @@ -1716,16 +1609,6 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - Unauthorized: - content: - application/json: - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized Forbidden: content: application/json: -- cgit 1.2.3-korg