diff options
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 3099 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi-inventory.yaml | 433 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 2335 |
3 files changed, 3071 insertions, 2796 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index c0c9dd6971..ace45f8447 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -1,809 +1,807 @@ -openapi: 3.0.1 +openapi: 3.0.3 info: - title: ONAP Open API v3 Configuration Persistence Service - description: Configuration Persistence Service is a Model Driven Generic Database contact: + email: onap-discuss@lists.onap.org name: ONAP url: https://onap.readthedocs.io - email: onap-discuss@lists.onap.org + description: Configuration Persistence Service is a Model Driven Generic Database license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 + title: ONAP Open API v3 Configuration Persistence Service version: 1.0.0 x-planned-retirement-date: "202212" x-component: Modeling x-logo: url: cps_logo.png servers: -- url: /cps/api + - url: /cps/api security: -- basicAuth: [] + - basicAuth: [] tags: -- name: cps-admin - description: cps Admin -- name: cps-data - description: cps Data + - description: cps Admin + name: cps-admin + - description: cps Data + name: cps-data paths: /v1/dataspaces: post: - tags: - - cps-admin - summary: Create a dataspace + deprecated: true description: Create a new dataspace operationId: createDataspace parameters: - - name: dataspace-name - in: query - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "201": - description: Created content: text/plain: schema: - type: string example: my-resource + type: string + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 - deprecated: true + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a dataspace + tags: + - cps-admin /{apiVersion}/dataspaces: delete: - tags: - - cps-admin - summary: Delete a dataspace description: Delete a dataspace operationId: deleteDataspace parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: query - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "204": - description: No Content content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Delete a dataspace + tags: + - cps-admin /v2/dataspaces: post: - tags: - - cps-admin - summary: Create a dataspace description: Create a new dataspace operationId: createDataspaceV2 parameters: - - name: dataspace-name - in: query - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "201": description: Created without response body "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a dataspace + tags: + - cps-admin /{apiVersion}/admin/dataspaces: get: - tags: - - cps-admin - summary: Get all dataspaces description: Read all dataspaces operationId: getAllDataspaces parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/DataspaceDetails' + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get all dataspaces + tags: + - cps-admin /{apiVersion}/admin/dataspaces/{dataspace-name}: get: - tags: - - cps-admin - summary: Get a dataspace description: Read a dataspace given a dataspace name operationId: getDataspace parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "200": - description: OK content: application/json: schema: $ref: '#/components/schemas/DataspaceDetails' + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get a dataspace + tags: + - cps-admin /v1/dataspaces/{dataspace-name}/anchors: post: - tags: - - cps-admin - summary: Create an anchor + deprecated: true description: Create a new anchor in the given dataspace operationId: createAnchor parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set - - name: anchor-name - in: query - description: anchor-name - required: true - schema: - type: string - example: my-anchor + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: query + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string + - description: anchor-name + in: query + name: anchor-name + required: true + schema: + example: my-anchor + type: string responses: "201": - description: Created content: text/plain: schema: - type: string example: my-resource + type: string + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 - deprecated: true + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create an anchor + tags: + - cps-admin /v2/dataspaces/{dataspace-name}/anchors: post: - tags: - - cps-admin - summary: Create an anchor description: Create a new anchor in the given dataspace operationId: createAnchorV2 parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set - - name: anchor-name - in: query - description: anchor-name - required: true - schema: - type: string - example: my-anchor + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: query + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string + - description: anchor-name + in: query + name: anchor-name + required: true + schema: + example: my-anchor + type: string responses: "201": description: Created without response body "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create an anchor + tags: + - cps-admin /{apiVersion}/dataspaces/{dataspace-name}/anchors: get: - tags: - - cps-admin - summary: Get anchors description: "Read all anchors, given a dataspace" operationId: getAnchors parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/AnchorDetails' + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}: - get: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get anchors tags: - - cps-admin - summary: Get an anchor - description: Read an anchor given an anchor name and a dataspace - operationId: getAnchor + - cps-admin + /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}: + delete: + description: Delete an anchor given an anchor name and a dataspace + operationId: deleteAnchor parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/AnchorDetails' + "204": + content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - delete: - tags: - - cps-admin + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error summary: Delete an anchor - description: Delete an anchor given an anchor name and a dataspace - operationId: deleteAnchor + tags: + - cps-admin + get: + description: Read an anchor given an anchor name and a dataspace + operationId: getAnchor parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string responses: - "204": - description: No Content - content: {} - "400": - description: Bad Request + "200": content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: '#/components/schemas/AnchorDetails' + description: OK + "400": + content: + application/json: example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get an anchor + tags: + - cps-admin /v1/dataspaces/{dataspace-name}/schema-sets: post: - tags: - - cps-admin - summary: Create a schema set + deprecated: true description: Create a new schema set in the given dataspace operationId: createSchemaSet parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: query + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string requestBody: content: multipart/form-data: @@ -812,85 +810,84 @@ paths: required: true responses: "201": - description: Created content: text/plain: schema: - type: string example: my-resource + type: string + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 - deprecated: true + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a schema set + tags: + - cps-admin /v2/dataspaces/{dataspace-name}/schema-sets: post: - tags: - - cps-admin - summary: Create a schema set description: Create a new schema set in the given dataspace operationId: createSchemaSetV2 parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: query + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string requestBody: content: multipart/form-data: @@ -901,1821 +898,1855 @@ paths: "201": description: Created without response body "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "409": - description: Conflict content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 409 message: Conflicting request details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a schema set + tags: + - cps-admin /{apiVersion}/dataspaces/{dataspace-name}/schema-sets: get: - tags: - - cps-admin - summary: Get schema sets description: "Read all schema sets, given a dataspace" operationId: getSchemaSets parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/SchemaSetDetails' + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}: - get: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get schema sets tags: - - cps-admin - summary: Get a schema set - description: Read a schema set given a schema set name and a dataspace - operationId: getSchemaSet + - cps-admin + /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}: + delete: + description: Delete a schema set given a schema set name and a dataspace + operationId: deleteSchemaSet parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: path - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: path + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SchemaSetDetails' + "204": + content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden - "500": - description: Internal Server Error + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "409": content: application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. schema: $ref: '#/components/schemas/ErrorMessage' + description: Conflict + "500": + content: + application/json: example: status: 500 message: Internal Server Error details: Internal Server Error occurred - delete: - tags: - - cps-admin + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error summary: Delete a schema set - description: Delete a schema set given a schema set name and a dataspace - operationId: deleteSchemaSet + tags: + - cps-admin + get: + description: Read a schema set given a schema set name and a dataspace + operationId: getSchemaSet parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: schema-set-name - in: path - description: schema-set-name - required: true - schema: - type: string - example: my-schema-set + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: schema-set-name + in: path + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string responses: - "204": - description: No Content - content: {} - "400": - description: Bad Request + "200": content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + $ref: '#/components/schemas/SchemaSetDetails' + description: OK + "400": + content: + application/json: example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden - "409": - description: Conflict - content: - application/json: schema: $ref: '#/components/schemas/ErrorMessage' - example: - status: 409 - message: Conflicting request - details: The request cannot be processed as the resource is in use. + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get a schema set + tags: + - cps-admin /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: get: - tags: - - cps-data - summary: Get a node + deprecated: true description: Get a node with an option to retrieve all the children for a given anchor and dataspace operationId: getNodeByDataspaceAndAnchor parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: include-descendants - in: query - description: include-descendants - required: false - schema: - type: boolean - example: false - default: false + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: include-descendants + in: query + name: include-descendants + required: false + schema: + default: false + example: false + type: boolean responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - deprecated: true + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get a node + tags: + - cps-data x-codegen-request-body-name: xpath /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: get: - tags: - - cps-data - summary: Get a node description: Get a node with an option to retrieve all the children for a given anchor and dataspace operationId: getNodeByDataspaceAndAnchorV2 parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: descendants - in: query - description: "Number of descendants to query. Allowed values are 'none', 'all',\ + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: "Number of descendants to query. Allowed values are 'none', 'all',\ \ -1 (for all), 0 (for none) and any positive number." - required: false - schema: - type: string - example: "3" - default: none + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get a node + tags: + - cps-data x-codegen-request-body-name: xpath /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes: - put: - tags: - - cps-data - summary: Replace a node with descendants - description: "Replace a node with descendants for a given dataspace, anchor\ - \ and a parent node xpath" - operationId: replaceNode + delete: + description: Delete a datanode for a given dataspace and anchor given a node + xpath. + operationId: deleteDataNode parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 - requestBody: - content: - application/json: - schema: - type: object - examples: - dataSample: - $ref: '#/components/examples/dataSample' - required: true + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string responses: - "200": - description: OK - content: - application/json: - schema: - type: object - examples: - dataSample: - value: "" + "204": + content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - post: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Delete a data node tags: - - cps-data - summary: Create a node - description: Create a node for a given anchor and dataspace - operationId: createNode + - cps-data + patch: + description: Update a data node leaves for a given dataspace and anchor and + a parent node xpath. This operation is currently supported for one top level + data node only. + operationId: updateNodeLeaves parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 - - name: Content-Type - in: header - description: Content type header - required: true - schema: - type: string - example: application/json + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string requestBody: content: application/json: - schema: - type: string examples: dataSample: $ref: '#/components/examples/dataSample' - application/xml: + value: null schema: type: object - xml: - name: stores - examples: - dataSample: - $ref: '#/components/examples/dataSampleXml' required: true responses: - "201": - description: Created + "200": content: - text/plain: + application/json: + examples: + dataSample: + value: "" schema: - type: string - example: my-resource + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden - "409": - description: Conflict - content: - application/json: schema: $ref: '#/components/schemas/ErrorMessage' - example: - status: 409 - message: Conflicting request - details: The request cannot be processed as the resource is in use. + description: Forbidden "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 - delete: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Update node leaves tags: - - cps-data - summary: Delete a data node - description: Delete a datanode for a given dataspace and anchor given a node - xpath. - operationId: deleteDataNode + - cps-data + post: + description: Create a node for a given anchor and dataspace + operationId: createNode parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string + - description: Content type header + in: header + name: Content-Type + required: true + schema: + example: application/json + type: string + requestBody: + content: + application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null + schema: + type: string + application/xml: + examples: + dataSample: + $ref: '#/components/examples/dataSampleXml' + value: null + schema: + type: object + xml: + name: stores required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 responses: - "204": - description: No Content - content: {} + "201": + content: + text/plain: + schema: + example: my-resource + type: string + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden - "500": - description: Internal Server Error + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "409": content: application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. schema: $ref: '#/components/schemas/ErrorMessage' + description: Conflict + "500": + content: + application/json: example: status: 500 message: Internal Server Error details: Internal Server Error occurred - patch: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a node tags: - - cps-data - summary: Update node leaves - description: Update a data node leaves for a given dataspace and anchor and - a parent node xpath. This operation is currently supported for one top level - data node only. - operationId: updateNodeLeaves + - cps-data + put: + description: "Replace a node with descendants for a given dataspace, anchor\ + \ and a parent node xpath" + operationId: replaceNode parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: false + schema: + default: / + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string requestBody: content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object required: true responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: value: "" + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Replace a node with descendants + tags: + - cps-data /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: delete: - tags: - - cps-data - summary: Delete one or all list element(s) + deprecated: true description: Delete one or all list element(s) for a given anchor and dataspace operationId: deleteListOrListElement parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: true - schema: - type: string - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: true + schema: + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string responses: "204": - description: No Content content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - deprecated: true - /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: - put: + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Delete one or all list element(s) tags: - - cps-data - summary: Replace list content - description: "Replace list content under a given parent, anchor and dataspace" - operationId: replaceListContent + - cps-data + /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: + post: + description: Add list element(s) to a list for a given anchor and dataspace + operationId: addListElements parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: true - schema: - type: string - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: true + schema: + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string requestBody: content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object required: true responses: - "200": - description: OK + "201": content: - application/json: + text/plain: schema: - type: object - examples: - dataSample: - value: "" + example: my-resource + type: string + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - post: - tags: - - cps-data + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error summary: Add list element(s) - description: Add list element(s) to a list for a given anchor and dataspace - operationId: addListElements + tags: + - cps-data + put: + description: "Replace list content under a given parent, anchor and dataspace" + operationId: replaceListContent parameters: - - name: apiVersion - in: path - description: apiVersion - required: true - schema: - type: string - default: v2 - enum: - - v1 - - v2 - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: xpath - in: query - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: true - schema: - type: string - examples: - container xpath: - value: /shops/bookstore - list attributes xpath: - value: "/shops/bookstore/categories[@code=1]" - - name: observed-timestamp - in: query - description: observed-timestamp - required: false - schema: - type: string - example: 2021-03-21T00:10:34.030-0100 + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + container xpath: + value: /shops/bookstore + list attributes xpath: + value: "/shops/bookstore/categories[@code=1]" + in: query + name: xpath + required: true + schema: + type: string + - description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string requestBody: content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object required: true responses: - "201": - description: Created + "200": content: - text/plain: + application/json: + examples: + dataSample: + value: "" schema: - type: string - example: my-resource + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Replace list content + tags: + - cps-data /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: get: - tags: - - cps-query - summary: Query data nodes + deprecated: true description: Query data nodes for the given dataspace and anchor using CPS path operationId: getNodesByDataspaceAndAnchorAndCpsPath parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: cps-path - in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false - schema: - type: string - default: / - examples: - container cps path: - value: //bookstore - list attributes cps path: - value: "//categories[@code=1]" - - name: include-descendants - in: query - description: include-descendants - required: false - schema: - type: boolean - example: false - default: false + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: "//categories[@code=1]" + in: query + name: cps-path + required: false + schema: + default: / + type: string + - description: include-descendants + in: query + name: include-descendants + required: false + schema: + default: false + example: false + type: boolean responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 - deprecated: true + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Query data nodes + tags: + - cps-query x-codegen-request-body-name: xpath /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: get: - tags: - - cps-query - summary: Query data nodes description: Query data nodes for the given dataspace and anchor using CPS path operationId: getNodesByDataspaceAndAnchorAndCpsPathV2 parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - example: my-anchor - - name: cps-path - in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false - schema: - type: string - default: / - examples: - container cps path: - value: //bookstore - list attributes cps path: - value: "//categories[@code=1]" - - name: descendants - in: query - description: "Number of descendants to query. Allowed values are 'none', 'all',\ + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: "//categories[@code=1]" + in: query + name: cps-path + required: false + schema: + default: / + type: string + - description: "Number of descendants to query. Allowed values are 'none', 'all',\ \ -1 (for all), 0 (for none) and any positive number." - required: false - schema: - type: string - example: "3" - default: none + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Query data nodes + tags: + - cps-query x-codegen-request-body-name: xpath /v2/dataspaces/{dataspace-name}/nodes/query: get: - tags: - - cps-query - summary: Query data nodes description: Query data nodes for the given dataspace across anchors using CPS path operationId: getNodesByDataspaceAndCpsPath parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - example: my-dataspace - - name: cps-path - in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false - schema: - type: string - default: / - examples: - container cps path: - value: //bookstore - list attributes cps path: - value: "//categories[@code=1]" - - name: descendants - in: query - description: "Number of descendants to query. Allowed values are 'none', 'all',\ + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: "//categories[@code=1]" + in: query + name: cps-path + required: false + schema: + default: / + type: string + - description: "Number of descendants to query. Allowed values are 'none', 'all',\ \ -1 (for all), 0 (for none) and any positive number." - required: false - schema: - type: string - example: "3" - default: none + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSample: $ref: '#/components/examples/dataSampleAcrossAnchors' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Bad Request details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized request details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Request Forbidden details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Query data nodes + tags: + - cps-query x-codegen-request-body-name: xpath components: - schemas: - ErrorMessage: - title: Error - type: object - properties: - status: - type: string - message: - type: string - details: - type: string - DataspaceDetails: - title: Dataspace details by dataspace Name - type: object - properties: - name: - type: string - example: my-dataspace - AnchorDetails: - title: Anchor details by anchor Name - type: object - properties: - name: - type: string - example: my-anchor - dataspaceName: - type: string - example: my-dataspace - schemaSetName: - type: string - example: my-schema-set - MultipartFile: - required: - - file - type: object - properties: - file: - type: string - description: multipartFile - format: binary - example: !!binary |- - aHR0cHM6Ly9naXRodWIuY29tL29uYXAvY3BzL2Jsb2IvbWFzdGVyL2Nwcy1zZXJ2aWNlL3NyYy90 - ZXN0L3Jlc291cmNlcy9ib29rc3RvcmUueWFuZw== - SchemaSetDetails: - title: Schema set details by dataspace and schemasetName - required: - - moduleReferences - type: object - properties: - dataspaceName: - type: string - example: my-dataspace - moduleReferences: - type: array - items: - $ref: '#/components/schemas/ModuleReferences' - name: - type: string - example: my-schema-set - ModuleReferences: - title: Module reference object - type: object - properties: - name: - type: string - example: my-module-reference-name - namespace: - type: string - example: my-module-reference-namespace - revision: - type: string - example: my-module-reference-revision - responses: - Created: - description: Created - content: - text/plain: - schema: - type: string - example: my-resource - BadRequest: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 400 - message: Bad Request - details: The provided request is not valid - Unauthorized: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 401 - message: Unauthorized request - details: This request is unauthorized - Forbidden: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 403 - message: Request Forbidden - details: This request is forbidden - Conflict: - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 409 - message: Conflicting request - details: The request cannot be processed as the resource is in use. - 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 - NoContent: - description: No Content - content: {} - CreatedV2: - description: Created without response body - Ok: - description: OK - content: - application/json: - schema: - type: object - examples: - dataSample: - value: "" + examples: + dataSample: + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: 1 + name: SciFi + - code: 2 + name: kids + dataSampleXml: + value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample"> + <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name> + </categories> </bookstore> </stores> + dataSampleAcrossAnchors: + value: + - anchorName: bookstore1 + dataNode: + test:bookstore: + bookstore-name: Chapters + categories: + - code: 1 + name: SciFi + - code: 2 + name: kids + - anchorName: bookstore2 + dataNode: + test:bookstore: + bookstore-name: Chapters + categories: + - code: 1 + name: SciFi + - code: 2 + name: kids parameters: dataspaceNameInQuery: - name: dataspace-name - in: query description: dataspace-name + in: query + name: dataspace-name required: true schema: - type: string example: my-dataspace + type: string apiVersionInPath: - name: apiVersion - in: path description: apiVersion + in: path + name: apiVersion required: true schema: - type: string default: v2 enum: - - v1 - - v2 + - v1 + - v2 + type: string dataspaceNameInPath: - name: dataspace-name - in: path description: dataspace-name + in: path + name: dataspace-name required: true schema: - type: string example: my-dataspace + type: string schemaSetNameInQuery: - name: schema-set-name - in: query description: schema-set-name + in: query + name: schema-set-name required: true schema: - type: string example: my-schema-set + type: string anchorNameInQuery: - name: anchor-name - in: query description: anchor-name + in: query + name: anchor-name required: true schema: - type: string example: my-anchor + type: string anchorNameInPath: - name: anchor-name - in: path description: anchor-name + in: path + name: anchor-name required: true schema: - type: string example: my-anchor + type: string schemaSetNameInPath: - name: schema-set-name - in: path description: schema-set-name + in: path + name: schema-set-name required: true schema: - type: string example: my-schema-set + type: string xpathInQuery: - name: xpath - in: query description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: false - schema: - type: string - default: / examples: container xpath: value: /shops/bookstore list attributes xpath: value: "/shops/bookstore/categories[@code=1]" - includeDescendantsOptionInQuery: - name: include-descendants in: query + name: xpath + required: false + schema: + default: / + type: string + includeDescendantsOptionInQuery: description: include-descendants + in: query + name: include-descendants required: false schema: - type: boolean - example: false default: false + example: false + type: boolean descendantsInQuery: - name: descendants - in: query description: "Number of descendants to query. Allowed values are 'none', 'all',\ \ -1 (for all), 0 (for none) and any positive number." + in: query + name: descendants required: false schema: - type: string - example: "3" default: none + example: "3" + type: string observedTimestampInQuery: - name: observed-timestamp - in: query description: observed-timestamp + in: query + name: observed-timestamp required: false schema: - type: string example: 2021-03-21T00:10:34.030-0100 + type: string contentTypeHeader: - name: Content-Type - in: header description: Content type header + in: header + name: Content-Type required: true schema: - type: string example: application/json + type: string requiredXpathInQuery: - name: xpath - in: query description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" - required: true - schema: - type: string examples: container xpath: value: /shops/bookstore list attributes xpath: value: "/shops/bookstore/categories[@code=1]" - cpsPathInQuery: - name: cps-path in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false + name: xpath + required: true schema: type: string - default: / + cpsPathInQuery: + description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" examples: container cps path: value: //bookstore list attributes cps path: value: "//categories[@code=1]" - examples: - dataSample: - value: - test:bookstore: - bookstore-name: Chapters - categories: - - code: 1 - name: SciFi - - code: 2 - name: kids - dataSampleXml: - value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample"> - <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name> - </categories> </bookstore> </stores> - dataSampleAcrossAnchors: - value: - - anchorName: bookstore1 - dataNode: - test:bookstore: - bookstore-name: Chapters - categories: - - code: 1 - name: SciFi - - code: 2 - name: kids - - anchorName: bookstore2 - dataNode: - test:bookstore: - bookstore-name: Chapters - categories: - - code: 1 - name: SciFi - - code: 2 - name: kids + in: query + name: cps-path + required: false + schema: + default: / + type: string + responses: + Created: + content: + text/plain: + schema: + example: my-resource + type: string + description: Created + BadRequest: + content: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid + 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: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + Conflict: + content: + application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict + InternalServerError: + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + NoContent: + content: {} + description: No Content + CreatedV2: + description: Created without response body + Ok: + content: + application/json: + examples: + dataSample: + value: "" + schema: + type: object + description: OK + schemas: + ErrorMessage: + properties: + status: + type: string + message: + type: string + details: + type: string + title: Error + type: object + DataspaceDetails: + example: + name: my-dataspace + properties: + name: + example: my-dataspace + type: string + title: Dataspace details by dataspace Name + type: object + AnchorDetails: + example: + schemaSetName: my-schema-set + dataspaceName: my-dataspace + name: my-anchor + properties: + name: + example: my-anchor + type: string + dataspaceName: + example: my-dataspace + type: string + schemaSetName: + example: my-schema-set + type: string + title: Anchor details by anchor Name + type: object + MultipartFile: + properties: + file: + description: multipartFile + example: !!binary |- + aHR0cHM6Ly9naXRodWIuY29tL29uYXAvY3BzL2Jsb2IvbWFzdGVyL2Nwcy1zZXJ2aWNlL3NyYy90 + ZXN0L3Jlc291cmNlcy9ib29rc3RvcmUueWFuZw== + format: binary + type: string + required: + - file + type: object + SchemaSetDetails: + example: + dataspaceName: my-dataspace + name: my-schema-set + moduleReferences: + - name: my-module-reference-name + namespace: my-module-reference-namespace + revision: my-module-reference-revision + - name: my-module-reference-name + namespace: my-module-reference-namespace + revision: my-module-reference-revision + properties: + dataspaceName: + example: my-dataspace + type: string + moduleReferences: + items: + $ref: '#/components/schemas/ModuleReferences' + type: array + name: + example: my-schema-set + type: string + required: + - moduleReferences + title: Schema set details by dataspace and schemasetName + type: object + ModuleReferences: + example: + name: my-module-reference-name + namespace: my-module-reference-namespace + revision: my-module-reference-revision + properties: + name: + example: my-module-reference-name + type: string + namespace: + example: my-module-reference-namespace + type: string + revision: + example: my-module-reference-revision + type: string + title: Module reference object + type: object securitySchemes: basicAuth: - type: http scheme: basic + type: http diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml index 2454de7efd..bb4cca0cb7 100644 --- a/docs/api/swagger/ncmp/openapi-inventory.yaml +++ b/docs/api/swagger/ncmp/openapi-inventory.yaml @@ -1,18 +1,15 @@ -openapi: 3.0.1 +openapi: 3.0.3 info: - title: NCMP Inventory API description: NCMP Inventory API + title: NCMP Inventory API version: "1.0" servers: -- url: /ncmpInventory + - url: /ncmpInventory security: -- basicAuth: [] + - basicAuth: [] paths: /v1/ch: post: - tags: - - network-cm-proxy-inventory - summary: DMI notifies NCMP of new CM Handles description: "Register a DMI Plugin with any new, updated or removed CM Handles." operationId: updateDmiPluginRegistration requestBody: @@ -23,137 +20,137 @@ paths: required: true responses: "200": - description: No Content content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "500": - description: Partial or Complete failure. The error details are provided - in the response body and all supported error codes are documented in the - example. content: application/json: - schema: - $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse' example: failedCreatedCmHandles: - - cmHandle: my-cm-handle-01 - errorCode: "00" - errorText: Unknown error. <error-details> - - cmHandle: my-cm-handle-02 - errorCode: "01" - errorText: cm-handle already exists - - cmHandle: my-cm-handle-03 - errorCode: "03" - errorText: cm-handle has an invalid character(s) in id + - cmHandle: my-cm-handle-01 + errorCode: "00" + errorText: Unknown error. <error-details> + - cmHandle: my-cm-handle-02 + errorCode: "01" + errorText: cm-handle already exists + - cmHandle: my-cm-handle-03 + errorCode: "03" + errorText: cm-handle has an invalid character(s) in id failedUpdatedCmHandles: - - cmHandle: my-cm-handle-01 - errorCode: "00" - errorText: Unknown error. <error-details> - - cmHandle: my-cm-handle-02 - errorCode: "02" - errorText: cm-handle does not exist - - cmHandle: my-cm-handle-03 - errorCode: "03" - errorText: cm-handle has an invalid character(s) in id + - cmHandle: my-cm-handle-01 + errorCode: "00" + errorText: Unknown error. <error-details> + - cmHandle: my-cm-handle-02 + errorCode: "02" + errorText: cm-handle does not exist + - cmHandle: my-cm-handle-03 + errorCode: "03" + errorText: cm-handle has an invalid character(s) in id failedRemovedCmHandles: - - cmHandle: my-cm-handle-01 - errorCode: "00" - errorText: Unknown error. <error-details> - - cmHandle: my-cm-handle-02 - errorCode: "02" - errorText: cm-handle does not exists - - cmHandle: my-cm-handle-03 - errorCode: "03" - errorText: cm-handle has an invalid character(s) in id + - cmHandle: my-cm-handle-01 + errorCode: "00" + errorText: Unknown error. <error-details> + - cmHandle: my-cm-handle-02 + errorCode: "02" + errorText: cm-handle does not exists + - cmHandle: my-cm-handle-03 + errorCode: "03" + errorText: cm-handle has an invalid character(s) in id + schema: + $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse' + description: Partial or Complete failure. The error details are provided + in the response body and all supported error codes are documented in the + example. + summary: DMI notifies NCMP of new CM Handles + tags: + - network-cm-proxy-inventory /v1/ch/cmHandles: get: - tags: - - network-cm-proxy-inventory - summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\ - \ data plugin, DMI model plugin)" description: Get all cm handle IDs for a registered DMI plugin operationId: getAllCmHandleIdsForRegisteredDmi parameters: - - name: dmi-plugin-identifier - in: query - description: dmi-plugin-identifier - required: true - schema: - type: string - example: my-dmi-plugin + - description: dmi-plugin-identifier + in: query + name: dmi-plugin-identifier + required: true + schema: + example: my-dmi-plugin + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: type: string + type: array + description: OK "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\ + \ data plugin, DMI model plugin)" + tags: + - network-cm-proxy-inventory /v1/ch/searches: post: - tags: - - network-cm-proxy-inventory - summary: Query for CM Handle IDs description: "Query and get CMHandleIds for additional properties, public properties\ \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)." operationId: searchCmHandleIds @@ -165,96 +162,192 @@ paths: required: true responses: "200": - description: OK content: application/json: schema: - type: array items: type: string + type: array + description: OK "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Query for CM Handle IDs + tags: + - network-cm-proxy-inventory components: + parameters: + dmiPluginIdentifierInQuery: + description: dmi-plugin-identifier + in: query + name: dmi-plugin-identifier + required: true + schema: + example: my-dmi-plugin + type: string + responses: + NoContent: + content: {} + description: No Content + BadRequest: + content: + application/json: + example: + status: 400 BAD_REQUEST + message: Bad request error message + details: Bad request error details + 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: + example: + status: 403 + message: Forbidden error message + details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + InternalServerError: + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error schemas: RestDmiPluginRegistration: - type: object + example: + updatedCmHandles: + - cmHandle: my-cm-handle + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + - cmHandle: my-cm-handle + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + createdCmHandles: + - cmHandle: my-cm-handle + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + - cmHandle: my-cm-handle + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property + dmiPlugin: my-dmi-plugin + dmiModelPlugin: my-dmi-model-plugin + dmiDataPlugin: my-dmi-data-plugin + removedCmHandles: + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 properties: dmiPlugin: - type: string - example: my-dmi-plugin default: "" - dmiDataPlugin: + example: my-dmi-plugin type: string - example: my-dmi-data-plugin + dmiDataPlugin: default: "" - dmiModelPlugin: + example: my-dmi-data-plugin type: string - example: my-dmi-model-plugin + dmiModelPlugin: default: "" + example: my-dmi-model-plugin + type: string createdCmHandles: - type: array items: $ref: '#/components/schemas/RestInputCmHandle' - updatedCmHandles: type: array + updatedCmHandles: items: $ref: '#/components/schemas/RestInputCmHandle' - removedCmHandles: type: array + removedCmHandles: example: - - my-cm-handle1 - - my-cm-handle2 - - my-cm-handle3 + - my-cm-handle1 + - my-cm-handle2 + - my-cm-handle3 items: type: string - RestInputCmHandle: - required: - - cmHandle + type: array type: object + RestInputCmHandle: + example: + cmHandle: my-cm-handle + publicCmHandleProperties: + key: my-property + cmHandleProperties: + key: my-property properties: cmHandle: - type: string example: my-cm-handle + type: string cmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' + additionalProperties: + example: my-property + type: string + type: object publicCmHandleProperties: - $ref: '#/components/schemas/RestCmHandleProperties' - RestCmHandleProperties: + additionalProperties: + example: my-property + type: string + type: object + required: + - cmHandle type: object + RestCmHandleProperties: additionalProperties: - type: string example: my-property - ErrorMessage: - title: Error + type: string type: object + ErrorMessage: properties: status: type: string @@ -262,125 +355,105 @@ components: type: string details: type: string - DmiPluginRegistrationErrorResponse: + title: Error type: object + DmiPluginRegistrationErrorResponse: properties: failedCreatedCmHandles: - type: array items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' - failedUpdatedCmHandles: type: array + failedUpdatedCmHandles: items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' - failedRemovedCmHandles: type: array + failedRemovedCmHandles: items: $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse' - CmHandlerRegistrationErrorResponse: + type: array type: object + CmHandlerRegistrationErrorResponse: properties: cmHandle: - type: string example: my-cm-handle - errorCode: type: string + errorCode: example: "00" - errorText: type: string + errorText: example: Unknown error. <error-details> - CmHandleQueryParameters: - title: Cm Handle query parameters for executing cm handle search + type: string type: object + CmHandleQueryParameters: + example: + cmHandleQueryParameters: + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + conditions: + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module properties: cmHandleQueryParameters: - type: array items: $ref: '#/components/schemas/ConditionProperties' - conditions: type: array - description: "not necessary, it is just for backward compatibility" + conditions: deprecated: true + description: "not necessary, it is just for backward compatibility" items: $ref: '#/components/schemas/OldConditionProperties' + type: array + title: Cm Handle query parameters for executing cm handle search + type: object ConditionProperties: + example: + conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName properties: conditionName: type: string conditionParameters: - type: array items: - type: object additionalProperties: type: string + type: object + type: array OldConditionProperties: + deprecated: true + example: + name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module properties: name: type: string conditionParameters: - type: array items: $ref: '#/components/schemas/ModuleNameAsJsonObject' - deprecated: true + type: array ModuleNameAsJsonObject: + example: + moduleName: my-module properties: moduleName: - type: string example: my-module - responses: - NoContent: - description: No Content - content: {} - BadRequest: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 400 BAD_REQUEST - message: Bad request error message - details: Bad request error details - Unauthorized: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - Forbidden: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 403 - message: Forbidden error message - details: Forbidden error details - 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 - parameters: - dmiPluginIdentifierInQuery: - name: dmi-plugin-identifier - in: query - description: dmi-plugin-identifier - required: true - schema: - type: string - example: my-dmi-plugin + type: string securitySchemes: basicAuth: - type: http scheme: basic + type: http diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index ea9786ef7f..a0c5b1710e 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -1,976 +1,980 @@ -openapi: 3.0.1 +openapi: 3.0.3 info: - title: NCMP to CPS Proxy API description: NCMP to CPS Proxy API + title: NCMP to CPS Proxy API version: "1.0" servers: -- url: /ncmp + - url: /ncmp security: -- basicAuth: [] + - basicAuth: [] paths: /v1/ch/{cm-handle}/data/ds/{datastore-name}: - get: - tags: - - network-cm-proxy - summary: Get resource data for cm handle - description: Get resource data for given cm handle - operationId: getResourceDataForCmHandle + delete: + description: Delete resource data from pass-through running for a given cm handle + operationId: deleteResourceDataRunningForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but - it can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - - name: options - in: query - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ - \ in parenthesis'()'. The format of options parameter depend on the associated\ - \ DMI Plugin implementation." - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - options: (depth=3) - sample 2: - value: - options: (fields=book) - sample 3: - value: - options: "(depth=2,fields=book/authors)" - - name: topic - in: query - description: topic parameter in query. - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - topic: my-topic-name - - name: include-descendants - in: query - description: Determines if descendants are included in response - required: false - schema: - type: boolean - default: false + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but + it can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + - description: "Content parameter for request, if content parameter is null,\ + \ default value is application/json." + in: header + name: Content-Type + required: false + schema: + default: application/json + example: application/yang-data+json + type: string responses: - "200": - description: OK - content: - application/json: - schema: - type: object - examples: - dataSampleResponse: - $ref: '#/components/examples/dataSampleResponse' + "204": + content: {} + description: No Content "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details - "500": - description: Internal Server Error + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "404": content: application/json: + example: + status: 400 + message: Not found error message + details: Not found error details schema: $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found + "500": + content: + application/json: example: status: 500 message: Internal Server Error details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request - put: + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Delete resource data tags: - - network-cm-proxy - summary: Update resource data from pass-through running for a cm handle - description: Update resource data from pass-through running for the given cm - handle - operationId: updateResourceDataRunningForCmHandle + - network-cm-proxy + get: + description: Get resource data for given cm handle + operationId: getResourceDataForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but - it can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - - name: Content-Type - in: header - description: "Content parameter for request, if content parameter is null,\ - \ default value is application/json." - required: false - schema: - type: string - example: application/yang-data+json - default: application/json - requestBody: - content: - application/json: - schema: - type: object - examples: - dataSampleRequest: - $ref: '#/components/examples/dataSampleRequest' - application/yang-data+json: - schema: - type: object - examples: - dataSampleRequest: - $ref: '#/components/examples/dataSampleRequest' - required: true + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but + it can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + - allowReserved: true + description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ + \ in parenthesis'()'. The format of options parameter depend on the associated\ + \ DMI Plugin implementation." + examples: + sample 1: + value: + options: (depth=3) + sample 2: + value: + options: (fields=book) + sample 3: + value: + options: "(depth=2,fields=book/authors)" + in: query + name: options + required: false + schema: + type: string + - allowReserved: true + description: topic parameter in query. + examples: + sample 1: + value: + topic: my-topic-name + in: query + name: topic + required: false + schema: + type: string + - description: Determines if descendants are included in response + in: query + name: include-descendants + required: false + schema: + default: false + type: boolean responses: "200": - description: OK content: application/json: + examples: + dataSampleResponse: + $ref: '#/components/examples/dataSampleResponse' + value: null schema: type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request - post: + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Get resource data for cm handle tags: - - network-cm-proxy - summary: create resource data from pass-through running for cm handle - description: create resource data from pass-through running for given cm handle - operationId: createResourceDataRunningForCmHandle + - network-cm-proxy + patch: + description: Patch resource data from pass-through running for the given cm + handle + operationId: patchResourceDataRunningForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but - it can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - - name: Content-Type - in: header - description: "Content parameter for request, if content parameter is null,\ + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but + it can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + - description: "Content parameter for request, if content parameter is null,\ \ default value is application/json." - required: false - schema: - type: string - example: application/yang-data+json - default: application/json + in: header + name: Content-Type + required: false + schema: + default: application/json + example: application/yang-data+json + type: string requestBody: content: - application/json: - schema: - type: object + '*/*': examples: dataSampleRequest: - $ref: '#/components/examples/dataSampleRequest' - application/yang-data+json: + $ref: '#/components/examples/dataSamplePatchRequest' + value: null schema: type: object - examples: - dataSampleRequest: - $ref: '#/components/examples/dataSampleRequest' required: true responses: - "201": - description: Created - content: {} - "400": - description: Bad Request + "200": content: application/json: schema: - $ref: '#/components/schemas/ErrorMessage' + type: object + description: OK + "400": + content: + application/json: example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request - delete: + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Patch resource data from pass-through running tags: - - network-cm-proxy - summary: Delete resource data - description: Delete resource data from pass-through running for a given cm handle - operationId: deleteResourceDataRunningForCmHandle + - network-cm-proxy + post: + description: create resource data from pass-through running for given cm handle + operationId: createResourceDataRunningForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but - it can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - - name: Content-Type - in: header - description: "Content parameter for request, if content parameter is null,\ + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but + it can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + - description: "Content parameter for request, if content parameter is null,\ \ default value is application/json." - required: false - schema: - type: string - example: application/yang-data+json - default: application/json + in: header + name: Content-Type + required: false + schema: + default: application/json + example: application/yang-data+json + type: string + requestBody: + content: + application/json: + examples: + dataSampleRequest: + $ref: '#/components/examples/dataSampleRequest' + value: null + schema: + type: object + application/yang-data+json: + examples: + dataSampleRequest: + $ref: '#/components/examples/dataSampleRequest' + value: null + schema: + type: object + required: true responses: - "204": - description: No Content + "201": content: {} + description: Created "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details - "404": - description: The specified resource was not found - content: - application/json: schema: $ref: '#/components/schemas/ErrorMessage' - example: - status: 400 - message: Not found error message - details: Not found error details + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request - patch: + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: create resource data from pass-through running for cm handle tags: - - network-cm-proxy - summary: Patch resource data from pass-through running - description: Patch resource data from pass-through running for the given cm + - network-cm-proxy + put: + description: Update resource data from pass-through running for the given cm handle - operationId: patchResourceDataRunningForCmHandle + operationId: updateResourceDataRunningForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but - it can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - - name: Content-Type - in: header - description: "Content parameter for request, if content parameter is null,\ + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but + it can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + - description: "Content parameter for request, if content parameter is null,\ \ default value is application/json." - required: false - schema: - type: string - example: application/yang-data+json - default: application/json + in: header + name: Content-Type + required: false + schema: + default: application/json + example: application/yang-data+json + type: string requestBody: content: - '*/*': + application/json: + examples: + dataSampleRequest: + $ref: '#/components/examples/dataSampleRequest' + value: null schema: type: object + application/yang-data+json: examples: dataSampleRequest: - $ref: '#/components/examples/dataSamplePatchRequest' + $ref: '#/components/examples/dataSampleRequest' + value: null + schema: + type: object required: true responses: "200": - description: OK content: application/json: schema: type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Update resource data from pass-through running for a cm handle + tags: + - network-cm-proxy /v1/data: post: - tags: - - network-cm-proxy - summary: Get resource data for batch of cm handle ids description: This request will be handled asynchronously using messaging to the supplied topic. The rest response will be an acknowledge with a requestId to identify the relevant messages. - operationId: getResourceDataForCmHandleBatch + operationId: executeDataOperationForCmHandles parameters: - - name: topic - in: query - description: mandatory topic parameter in query. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - topic: my-topic-name + - allowReserved: true + description: mandatory topic parameter in query. + examples: + sample 1: + value: + topic: my-topic-name + in: query + name: topic + required: true + schema: + type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResourceDataBatchRequest' + $ref: '#/components/schemas/DataOperationRequest' required: true responses: "200": - description: OK content: application/json: schema: type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Execute a data operation for group of cm handle ids + tags: + - network-cm-proxy /v1/ch/{cm-handle}/data/ds/{datastore-name}/query: get: - tags: - - network-cm-proxy - summary: Query resource data for a given cm handle description: Query resource data for a given cm handle operationId: queryResourceDataForCmHandle parameters: - - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: cps-path - in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false - schema: - type: string - default: / - examples: - container cps path: - value: //bookstore - list attributes cps path: - value: "//categories[@code=1]" - - name: options - in: query - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: "//categories[@code=1]" + in: query + name: cps-path + required: false + schema: + default: / + type: string + - allowReserved: true + description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ \ in parenthesis'()'. The format of options parameter depend on the associated\ \ DMI Plugin implementation." - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - options: (depth=3) - sample 2: - value: - options: (fields=book) - sample 3: - value: - options: "(depth=2,fields=book/authors)" - - name: topic - in: query - description: topic parameter in query. - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - topic: my-topic-name - - name: include-descendants - in: query - description: Determines if descendants are included in response - required: false - schema: - type: boolean - default: false + examples: + sample 1: + value: + options: (depth=3) + sample 2: + value: + options: (fields=book) + sample 3: + value: + options: "(depth=2,fields=book/authors)" + in: query + name: options + required: false + schema: + type: string + - allowReserved: true + description: topic parameter in query. + examples: + sample 1: + value: + topic: my-topic-name + in: query + name: topic + required: false + schema: + type: string + - description: Determines if descendants are included in response + in: query + name: include-descendants + required: false + schema: + default: false + type: boolean responses: "200": - description: OK content: application/json: - schema: - type: object examples: dataSampleResponse: $ref: '#/components/examples/dataSampleResponse' + value: null + schema: + type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Query resource data for a given cm handle + tags: + - network-cm-proxy /v1/ch/{cm-handle}/modules: get: - tags: - - network-cm-proxy - summary: Fetch all module references (name and revision) for a given cm handle description: fetch all module references (name and revision) for a given cm handle operationId: getModuleReferencesByCmHandle parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/RestModuleReference' + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Fetch all module references (name and revision) for a given cm handle + tags: + - network-cm-proxy /v1/ch/{cm-handle}/modules/definitions: get: - tags: - - network-cm-proxy - summary: "Fetch all module definitions (name, revision, yang resource) for a\ - \ given cm handle" description: "Fetch all module definitions (name, revision, yang resource) for\ \ a given cm handle" operationId: getModuleDefinitionsByCmHandleId parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/RestModuleDefinition' + type: array + description: OK "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: "Fetch all module definitions (name, revision, yang resource) for a\ + \ given cm handle" + tags: + - network-cm-proxy /v1/ch/searches: post: - tags: - - network-cm-proxy - summary: Execute cm handle search using the available conditions description: Execute cm handle query search and return a list of cm handle details. Any number of conditions can be applied. To be included in the result a cm-handle must fulfill ALL the conditions. An empty collection will be returned in the @@ -985,200 +989,205 @@ paths: requestBody: content: application/json: - schema: - $ref: '#/components/schemas/CmHandleQueryParameters' examples: Cm handle properties query: $ref: '#/components/examples/pubPropCmHandleQueryParameters' + value: null Cm handle modules query: $ref: '#/components/examples/modulesCmHandleQueryParameters' + value: null All cm handle query parameters: $ref: '#/components/examples/allCmHandleQueryParameters' + value: null Cm handle with CPS path state query: $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters' + value: null Cm handle with data sync flag query: $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters' + value: null + schema: + $ref: '#/components/schemas/CmHandleQueryParameters' required: true responses: "200": - description: OK content: application/json: schema: - type: array items: $ref: '#/components/schemas/RestOutputCmHandle' + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Execute cm handle search using the available conditions + tags: + - network-cm-proxy /v1/ch/{cm-handle}: get: - tags: - - network-cm-proxy - summary: Retrieve CM handle details description: Retrieve CM handle details and properties by cm handle id operationId: retrieveCmHandleDetailsById parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string responses: "200": - description: OK content: application/json: schema: $ref: '#/components/schemas/RestOutputCmHandle' + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "404": - description: The specified resource was not found content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Not found error message details: Not found error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Retrieve CM handle details + tags: + - network-cm-proxy /v1/ch/{cm-handle}/properties: get: - tags: - - network-cm-proxy - summary: Get CM handle properties description: Get CM handle properties by cm handle id operationId: getCmHandlePublicPropertiesByCmHandleId parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string responses: "200": - description: OK content: application/json: schema: $ref: '#/components/schemas/RestOutputCmHandlePublicProperties' + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "404": - description: The specified resource was not found content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Not found error message details: Not found error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get CM handle properties + tags: + - network-cm-proxy /v1/ch/id-searches: post: - tags: - - network-cm-proxy - summary: Execute cm handle query upon a given set of query parameters description: Execute cm handle query search and return a list of cm handle ids. Any number of conditions can be applied. To be included in the result a cm-handle must fulfill ALL the conditions. An empty collection will be returned in the @@ -1193,230 +1202,554 @@ paths: requestBody: content: application/json: - schema: - $ref: '#/components/schemas/CmHandleQueryParameters' examples: Cm handle properties query: $ref: '#/components/examples/pubPropCmHandleQueryParameters' + value: null Cm handle modules query: $ref: '#/components/examples/modulesCmHandleQueryParameters' + value: null All cm handle query parameters: $ref: '#/components/examples/allCmHandleQueryParameters' + value: null Cm handle with CPS path state query: $ref: '#/components/examples/cpsPathCmHandleStateQueryParameters' + value: null Cm handle with data sync flag query: $ref: '#/components/examples/cpsPathCmHandleDataSyncQueryParameters' + value: null + schema: + $ref: '#/components/schemas/CmHandleQueryParameters' required: true responses: "200": - description: OK content: application/json: schema: - type: array items: type: string + type: array + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "404": - description: The specified resource was not found content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Not found error message details: Not found error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Execute cm handle query upon a given set of query parameters + tags: + - network-cm-proxy /v1/ch/{cm-handle}/state: get: - tags: - - network-cm-proxy - summary: Get CM handle state description: Get CM handle state by cm handle id operationId: getCmHandleStateByCmHandleId parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string responses: "200": - description: OK content: application/json: schema: $ref: '#/components/schemas/RestOutputCmHandleCompositeState' + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "404": - description: The specified resource was not found content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 message: Not found error message details: Not found error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get CM handle state + tags: + - network-cm-proxy /v1/ch/{cm-handle}/data-sync: put: - tags: - - network-cm-proxy - summary: Set the Data Sync Enabled Flag description: Set the data sync enabled flag to true or false for a specified Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and NONE_REQUESTED respectfully. operationId: setDataSyncEnabledFlagForCmHandle parameters: - - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ + - description: "The identifier for a network function, network element, subnetwork\ \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - - name: dataSyncEnabled - in: query - description: Is used to enable or disable the data synchronization flag - required: true - schema: - type: boolean - example: true + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + - description: Is used to enable or disable the data synchronization flag + in: query + name: dataSyncEnabled + required: true + schema: + example: true + type: boolean responses: "200": - description: OK content: application/json: schema: type: object + description: OK "400": - description: Bad Request content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 400 BAD_REQUEST message: Bad request error message details: Bad request error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request "401": - description: Unauthorized content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 401 message: Unauthorized error message details: Unauthorized error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' example: status: 403 message: Forbidden error message details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden "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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error "502": - description: Bad Gateway content: application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' example: message: Bad Gateway Error Message NCMP dmi-response: http-code: 400 body: Bad Request + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + summary: Set the Data Sync Enabled Flag + tags: + - network-cm-proxy components: + examples: + dataSampleResponse: + description: Sample response for selecting 'sample 1'. + summary: Sample response + value: + bookstore: + categories: + - code: "01" + books: + - authors: + - Iain M. Banks + - Ursula K. Le Guin + name: SciFi + - code: "02" + books: + - authors: + - Philip Pullman + name: kids + dataSampleRequest: + description: Sample request body + summary: Sample request + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: "01" + name: SciFi + books: + - authors: + - Iain M. Banks + - Ursula K. Le Guin + - code: "02" + name: kids + books: + - authors: + - Philip Pullman + dataSamplePatchRequest: + description: Sample patch request body + summary: Sample patch request + 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 + pubPropCmHandleQueryParameters: + value: + cmHandleQueryParameters: + - conditionName: hasAllProperties + conditionParameters: + - Color: yellow + - Shape: circle + - Size: small + modulesCmHandleQueryParameters: + value: + cmHandleQueryParameters: + - conditionName: hasAllModules + conditionParameters: + - moduleName: my-module-1 + - moduleName: my-module-2 + - moduleName: my-module-3 + allCmHandleQueryParameters: + value: + cmHandleQueryParameters: + - conditionName: hasAllModules + conditionParameters: + - moduleName: my-module-1 + - moduleName: my-module-2 + - moduleName: my-module-3 + - conditionName: hasAllProperties + conditionParameters: + - Color: yellow + - Shape: circle + - Size: small + - conditionName: cmHandleWithCpsPath + conditionParameters: + - cpsPath: "//state[@cm-handle-state='ADVISED']" + cpsPathCmHandleStateQueryParameters: + value: + cmHandleQueryParameters: + - conditionName: cmHandleWithCpsPath + conditionParameters: + - cpsPath: "//state[@cm-handle-state='LOCKED']" + cpsPathCmHandleDataSyncQueryParameters: + value: + cmHandleQueryParameters: + - conditionName: cmHandleWithCpsPath + conditionParameters: + - cpsPath: "//state[@data-sync-enabled='true']" + parameters: + datastoreName: + description: The type of the requested data + in: path + name: datastore-name + required: true + schema: + example: ncmp-datastore:running + type: string + cmHandleInPath: + description: "The identifier for a network function, network element, subnetwork\ + \ or any other cm object by managed Network CM Proxy" + in: path + name: cm-handle + required: true + schema: + example: my-cm-handle + type: string + resourceIdentifierInQuery: + allowReserved: true + description: The format of resource identifier depend on the associated DMI + Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it + can really be anything. + examples: + sample 1: + value: + resourceIdentifier: \shops\bookstore + sample 2: + value: + resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" + sample 3: + value: + resourceIdentifier: "parent=shops,child=bookstore" + in: query + name: resourceIdentifier + required: true + schema: + type: string + optionsParamInQuery: + allowReserved: true + description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ + \ in parenthesis'()'. The format of options parameter depend on the associated\ + \ DMI Plugin implementation." + examples: + sample 1: + value: + options: (depth=3) + sample 2: + value: + options: (fields=book) + sample 3: + value: + options: "(depth=2,fields=book/authors)" + in: query + name: options + required: false + schema: + type: string + topicParamInQuery: + allowReserved: true + description: topic parameter in query. + examples: + sample 1: + value: + topic: my-topic-name + in: query + name: topic + required: false + schema: + type: string + includeDescendantsOptionInQuery: + description: Determines if descendants are included in response + in: query + name: include-descendants + required: false + schema: + default: false + type: boolean + contentParamInHeader: + description: "Content parameter for request, if content parameter is null, default\ + \ value is application/json." + in: header + name: Content-Type + required: false + schema: + default: application/json + example: application/yang-data+json + type: string + requiredTopicParamInQuery: + allowReserved: true + description: mandatory topic parameter in query. + examples: + sample 1: + value: + topic: my-topic-name + in: query + name: topic + required: true + schema: + type: string + cpsPathInQuery: + description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" + examples: + container cps path: + value: //bookstore + list attributes cps path: + value: "//categories[@code=1]" + in: query + name: cps-path + required: false + schema: + default: / + type: string + dataSyncEnabled: + description: Is used to enable or disable the data synchronization flag + in: query + name: dataSyncEnabled + required: true + schema: + example: true + type: boolean + responses: + BadRequest: + content: + application/json: + example: + status: 400 BAD_REQUEST + message: Bad request error message + details: Bad request error details + 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: + example: + status: 403 + message: Forbidden error message + details: Forbidden error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + InternalServerError: + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + BadGateway: + content: + application/json: + example: + message: Bad Gateway Error Message NCMP + dmi-response: + http-code: 400 + body: Bad Request + schema: + $ref: '#/components/schemas/DmiErrorMessage' + description: Bad Gateway + Ok: + content: + application/json: + schema: + type: object + description: OK + Created: + content: {} + description: Created + NoContent: + content: {} + description: No Content + NotFound: + content: + application/json: + example: + status: 400 + message: Not found error message + details: Not found error details + schema: + $ref: '#/components/schemas/ErrorMessage' + description: The specified resource was not found schemas: ErrorMessage: - title: Error - type: object properties: status: type: string @@ -1424,519 +1757,357 @@ components: type: string details: type: string - DmiErrorMessage: - title: DMI Error Message + title: Error type: object + DmiErrorMessage: properties: message: - type: string example: Bad Gateway Error Message NCMP + type: string dmi-response: - $ref: '#/components/schemas/DmiErrorMessage_dmiresponse' - ResourceDataBatchRequest: - title: get resource data for given array of operations + $ref: '#/components/schemas/DmiErrorMessage_dmi_response' + title: DMI Error Message type: object + DataOperationRequest: + example: + operations: + - resourceIdentifier: parent/child + targetIds: + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + datastore: ncmp-datastore:passthrough-operational + options: (fields=schemas/schema) + operationId: "12" + operation: read + - resourceIdentifier: parent/child + targetIds: + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + datastore: ncmp-datastore:passthrough-operational + options: (fields=schemas/schema) + operationId: "12" + operation: read properties: operations: - type: array - description: contains batch request details + description: contains group of data operation requests items: - $ref: '#/components/schemas/BatchOperationDefinition' - BatchOperationDefinition: - required: - - datastore - - operation - - operationId + $ref: '#/components/schemas/DataOperationDefinition' + type: array + title: execute data operation for given array of operations + type: object + DataOperationDefinition: + example: + resourceIdentifier: parent/child + targetIds: + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + - "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" + datastore: ncmp-datastore:passthrough-operational + options: (fields=schemas/schema) + operationId: "12" + operation: read properties: operation: - type: string example: read - operationId: type: string + operationId: example: "12" - datastore: type: string + datastore: example: ncmp-datastore:passthrough-operational - options: type: string + options: example: (fields=schemas/schema) - resourceIdentifier: type: string + resourceIdentifier: example: parent/child + type: string targetIds: - type: array - example: - - da310eecdb8d44c2acc0ddaae01174b1 - - c748c58f8e0b438f9fd1f28370b17d47 items: + example: "[\"da310eecdb8d44c2acc0ddaae01174b1\",\"c748c58f8e0b438f9fd1f28370b17d47\"\ + ]" type: string + type: array + required: + - datastore + - operation + - operationId RestModuleReference: - title: Module reference details - type: object + example: + moduleName: my-module-name + revision: my-module-revision properties: moduleName: - type: string example: my-module-name - revision: type: string + revision: example: my-module-revision - RestModuleDefinition: - title: Module definitions + type: string + title: Module reference details type: object + RestModuleDefinition: + example: + moduleName: my-module-name + content: | + module stores { + yang-version 1.1; + namespace 'org:onap:ccsdk:sample'; + prefix book-store; + revision '2020-09-15' { + description + 'Sample Model'; + } + } + revision: 2020-09-15 properties: moduleName: - type: string example: my-module-name - revision: type: string + revision: example: 2020-09-15 - content: type: string + content: example: | module stores { yang-version 1.1; - namespace "org:onap:ccsdk:sample"; + namespace 'org:onap:ccsdk:sample'; prefix book-store; - revision "2020-09-15" { + revision '2020-09-15' { description - "Sample Model"; + 'Sample Model'; } } - CmHandleQueryParameters: - title: Cm Handle query parameters for executing cm handle search + type: string + title: Module definitions type: object + CmHandleQueryParameters: + example: + cmHandleQueryParameters: + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + - conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName + conditions: + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module + - name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module properties: cmHandleQueryParameters: - type: array items: $ref: '#/components/schemas/ConditionProperties' - conditions: type: array - description: "not necessary, it is just for backward compatibility" + conditions: deprecated: true + description: "not necessary, it is just for backward compatibility" items: $ref: '#/components/schemas/OldConditionProperties' + type: array + title: Cm Handle query parameters for executing cm handle search + type: object ConditionProperties: + example: + conditionParameters: + - key: conditionParameters + - key: conditionParameters + conditionName: conditionName properties: conditionName: type: string conditionParameters: - type: array items: - type: object additionalProperties: type: string + type: object + type: array OldConditionProperties: + deprecated: true + example: + name: name + conditionParameters: + - moduleName: my-module + - moduleName: my-module properties: name: type: string conditionParameters: - type: array items: $ref: '#/components/schemas/ModuleNameAsJsonObject' - deprecated: true + type: array ModuleNameAsJsonObject: + example: + moduleName: my-module properties: moduleName: - type: string example: my-module + type: string RestOutputCmHandle: - title: CM handle Details - type: object + example: + cmHandle: my-cm-handle1 + publicCmHandleProperties: + - key: Book Type + - key: Book Type + state: + dataSyncEnabled: false + dataSyncState: + running: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + operational: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + cmHandleState: ADVISED + lockReason: + reason: LOCKED_MISBEHAVING + details: locked due to failure in module sync + lastUpdateTime: 2022-12-31T20:30:40.000+0000 properties: cmHandle: - type: string example: my-cm-handle1 + type: string publicCmHandleProperties: - $ref: '#/components/schemas/CmHandlePublicProperties' + items: + additionalProperties: + example: Book Type + type: string + type: object + type: array state: $ref: '#/components/schemas/CmHandleCompositeState' + title: CM handle Details + type: object CmHandlePublicProperties: - type: array items: - type: object additionalProperties: - type: string example: Book Type + type: string + type: object + type: array CmHandleCompositeState: - type: object + example: + dataSyncEnabled: false + dataSyncState: + running: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + operational: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + cmHandleState: ADVISED + lockReason: + reason: LOCKED_MISBEHAVING + details: locked due to failure in module sync + lastUpdateTime: 2022-12-31T20:30:40.000+0000 properties: cmHandleState: - type: string example: ADVISED + type: string lockReason: $ref: '#/components/schemas/lock-reason' lastUpdateTime: - type: string example: 2022-12-31T20:30:40.000+0000 + type: string dataSyncEnabled: - type: boolean example: false + type: boolean dataSyncState: $ref: '#/components/schemas/dataStores' - lock-reason: type: object + lock-reason: + example: + reason: LOCKED_MISBEHAVING + details: locked due to failure in module sync properties: reason: - type: string example: LOCKED_MISBEHAVING - details: type: string + details: example: locked due to failure in module sync - dataStores: + type: string type: object + dataStores: + example: + running: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + operational: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED properties: operational: $ref: '#/components/schemas/sync-state' running: $ref: '#/components/schemas/sync-state' - sync-state: type: object + sync-state: + example: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED properties: syncState: - type: string example: NONE_REQUESTED - lastSyncTime: type: string + lastSyncTime: example: 2022-12-31T20:30:40.000+0000 - RestOutputCmHandlePublicProperties: + type: string type: object + RestOutputCmHandlePublicProperties: + example: + publicCmHandleProperties: + - key: Book Type + - key: Book Type properties: publicCmHandleProperties: - $ref: '#/components/schemas/CmHandlePublicProperties' - RestOutputCmHandleCompositeState: + items: + additionalProperties: + example: Book Type + type: string + type: object + type: array type: object + RestOutputCmHandleCompositeState: + example: + state: + dataSyncEnabled: false + dataSyncState: + running: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + operational: + lastSyncTime: 2022-12-31T20:30:40.000+0000 + syncState: NONE_REQUESTED + cmHandleState: ADVISED + lockReason: + reason: LOCKED_MISBEHAVING + details: locked due to failure in module sync + lastUpdateTime: 2022-12-31T20:30:40.000+0000 properties: state: $ref: '#/components/schemas/CmHandleCompositeState' - DmiErrorMessage_dmiresponse: type: object + DmiErrorMessage_dmi_response: properties: http-code: - type: integer example: 400 + type: integer body: - type: string example: Bad Request - responses: - BadRequest: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 400 BAD_REQUEST - message: Bad request error message - details: Bad request error details - Unauthorized: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 401 - message: Unauthorized error message - details: Unauthorized error details - Forbidden: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 403 - message: Forbidden error message - details: Forbidden error details - 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 - BadGateway: - description: Bad Gateway - content: - application/json: - schema: - $ref: '#/components/schemas/DmiErrorMessage' - example: - message: Bad Gateway Error Message NCMP - dmi-response: - http-code: 400 - body: Bad Request - Ok: - description: OK - content: - application/json: - schema: - type: object - Created: - description: Created - content: {} - NoContent: - description: No Content - content: {} - NotFound: - description: The specified resource was not found - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - example: - status: 400 - message: Not found error message - details: Not found error details - parameters: - datastoreName: - name: datastore-name - in: path - description: The type of the requested data - required: true - schema: - type: string - example: ncmp-datastore:running - cmHandleInPath: - name: cm-handle - in: path - description: "The identifier for a network function, network element, subnetwork\ - \ or any other cm object by managed Network CM Proxy" - required: true - schema: - type: string - example: my-cm-handle - resourceIdentifierInQuery: - name: resourceIdentifier - in: query - description: The format of resource identifier depend on the associated DMI - Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but it - can really be anything. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - resourceIdentifier: \shops\bookstore - sample 2: - value: - resourceIdentifier: "\\shops\\bookstore\\categories[@code=1]" - sample 3: - value: - resourceIdentifier: "parent=shops,child=bookstore" - optionsParamInQuery: - name: options - in: query - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ - \ in parenthesis'()'. The format of options parameter depend on the associated\ - \ DMI Plugin implementation." - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - options: (depth=3) - sample 2: - value: - options: (fields=book) - sample 3: - value: - options: "(depth=2,fields=book/authors)" - topicParamInQuery: - name: topic - in: query - description: topic parameter in query. - required: false - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - topic: my-topic-name - includeDescendantsOptionInQuery: - name: include-descendants - in: query - description: Determines if descendants are included in response - required: false - schema: - type: boolean - default: false - contentParamInHeader: - name: Content-Type - in: header - description: "Content parameter for request, if content parameter is null, default\ - \ value is application/json." - required: false - schema: - type: string - example: application/yang-data+json - default: application/json - requiredTopicParamInQuery: - name: topic - in: query - description: mandatory topic parameter in query. - required: true - allowReserved: true - schema: - type: string - examples: - sample 1: - value: - topic: my-topic-name - cpsPathInQuery: - name: cps-path - in: query - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html" - required: false - schema: - type: string - default: / - examples: - container cps path: - value: //bookstore - list attributes cps path: - value: "//categories[@code=1]" - dataSyncEnabled: - name: dataSyncEnabled - in: query - description: Is used to enable or disable the data synchronization flag - required: true - schema: - type: boolean - example: true - examples: - dataSampleResponse: - summary: Sample response - description: Sample response for selecting 'sample 1'. - value: - bookstore: - categories: - - code: "01" - books: - - authors: - - Iain M. Banks - - Ursula K. Le Guin - name: SciFi - - code: "02" - books: - - authors: - - Philip Pullman - name: kids - dataSampleRequest: - summary: Sample request - description: Sample request body - value: - test:bookstore: - bookstore-name: Chapters - categories: - - code: "01" - name: SciFi - books: - - authors: - - Iain M. Banks - - Ursula K. Le Guin - - code: "02" - name: kids - books: - - 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 - pubPropCmHandleQueryParameters: - value: - cmHandleQueryParameters: - - conditionName: hasAllProperties - conditionParameters: - - Color: yellow - - Shape: circle - - Size: small - modulesCmHandleQueryParameters: - value: - cmHandleQueryParameters: - - conditionName: hasAllModules - conditionParameters: - - moduleName: my-module-1 - - moduleName: my-module-2 - - moduleName: my-module-3 - allCmHandleQueryParameters: - value: - cmHandleQueryParameters: - - conditionName: hasAllModules - conditionParameters: - - moduleName: my-module-1 - - moduleName: my-module-2 - - moduleName: my-module-3 - - conditionName: hasAllProperties - conditionParameters: - - Color: yellow - - Shape: circle - - Size: small - - conditionName: cmHandleWithCpsPath - conditionParameters: - - cpsPath: "//state[@cm-handle-state='ADVISED']" - cpsPathCmHandleStateQueryParameters: - value: - cmHandleQueryParameters: - - conditionName: cmHandleWithCpsPath - conditionParameters: - - cpsPath: "//state[@cm-handle-state='LOCKED']" - cpsPathCmHandleDataSyncQueryParameters: - value: - cmHandleQueryParameters: - - conditionName: cmHandleWithCpsPath - conditionParameters: - - cpsPath: "//state[@data-sync-enabled='true']" + type: string + type: object securitySchemes: basicAuth: - type: http scheme: basic + type: http |