diff options
author | mpriyank <priyank.maheshwari@est.tech> | 2024-02-29 14:39:00 +0000 |
---|---|---|
committer | mpriyank <priyank.maheshwari@est.tech> | 2024-02-29 14:58:34 +0000 |
commit | 4a978d3c66da16bc96b54cba807138fc9b0c79fa (patch) | |
tree | 20457d947ba6d9e0bc63eefda350ebdca97bb46e /docs/api | |
parent | c5222a72ef11bd440f5c2bd017e820922ff6735a (diff) |
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 <priyank.maheshwari@est.tech>
Diffstat (limited to 'docs/api')
-rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 290 | ||||
-rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 40 | ||||
-rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 203 |
3 files changed, 43 insertions, 490 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index bade85ef1a..2798b78643 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -55,16 +55,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -134,16 +124,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -202,16 +182,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -279,16 +249,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -351,16 +311,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -429,16 +379,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -511,16 +451,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -595,16 +525,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -671,16 +591,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -749,16 +659,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -826,16 +726,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -907,16 +797,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -991,16 +871,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1067,16 +937,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1155,16 +1015,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1250,16 +1100,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1347,16 +1187,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1444,16 +1274,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1556,16 +1376,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1680,16 +1490,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1801,16 +1601,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1886,16 +1676,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -1994,16 +1774,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2103,16 +1873,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2205,16 +1965,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2300,16 +2050,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2396,16 +2136,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2502,16 +2232,6 @@ paths: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - "401": - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized "403": content: application/json: @@ -2766,16 +2486,6 @@ components: schema: $ref: '#/components/schemas/ErrorMessage' description: Bad Request - Unauthorized: - content: - application/json: - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - schema: - $ref: '#/components/schemas/ErrorMessage' - description: Unauthorized Forbidden: content: application/json: diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 53f51f3f8b..ff9f4ba683 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 a1cc5d9ba7..9203b6d4ca 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: |