X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi%2Fswagger%2Fcps%2Fopenapi.yaml;h=12b438a3e6192832dfa7060a1f1478a5fafd795f;hb=f248b5d9b794d5bdff59145406e0398d6fdcafa4;hp=fb219eb6523fbfc95dd01ad2530ec53c9f4a4f14;hpb=44beaa34486d0624175c42cc3899a0b53befd9a8;p=cps.git diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index fb219eb65..12b438a3e 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -1,987 +1,2771 @@ -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: [] 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 + - description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "201": - description: Created content: text/plain: schema: + example: my-resource type: string + description: Created "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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' - /v1/dataspaces/{dataspace-name}/anchors: - get: + description: Conflict + "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 + summary: Create a dataspace tags: - - cps-admin - summary: Get anchors - description: "Read all anchors, given a dataspace" - operationId: getAnchors + - cps-admin + /{apiVersion}/dataspaces: + delete: + description: Delete a dataspace + operationId: deleteDataspace parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string + - 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: - "200": - description: OK + "204": + content: {} + description: No Content + "400": content: application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid schema: - type: array - items: - $ref: '#/components/schemas/AnchorDetails' - "400": + $ref: '#/components/schemas/ErrorMessage' description: Bad Request + "401": content: application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' - "401": description: Unauthorized + "403": content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "403": 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' - "404": - description: The specified resource was not found + description: Conflict + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - post: + description: Internal Server Error + summary: Delete a dataspace tags: - - cps-admin - summary: Create an anchor - description: Create a new anchor in the given dataspace - operationId: createAnchor + - cps-admin + /v2/dataspaces: + post: + description: Create a new dataspace + operationId: createDataspaceV2 parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - - name: anchor-name - in: query - description: anchor-name - required: true - schema: - type: string + - description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string responses: "201": - description: Created + description: Created without response body + "400": content: - text/plain: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid schema: - type: string - "400": + $ref: '#/components/schemas/ErrorMessage' description: Bad Request + "401": content: application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' - "401": description: Unauthorized + "403": content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "403": 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' - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}: - get: + description: Conflict + "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 + summary: Create a dataspace tags: - - cps-admin - summary: Get an anchor - description: Read an anchor given an anchor name and a dataspace - operationId: getAnchor + - cps-admin + /{apiVersion}/admin/dataspaces: + get: + description: Read all dataspaces + operationId: getAllDataspaces parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string responses: "200": - description: OK content: application/json: schema: - $ref: '#/components/schemas/AnchorDetails' + items: + $ref: '#/components/schemas/DataspaceDetails' + type: array + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - delete: + description: Internal Server Error + summary: Get all dataspaces tags: - - cps-admin - summary: Delete an anchor - description: Delete an anchor given an anchor name and a dataspace - operationId: deleteAnchor + - cps-admin + /{apiVersion}/admin/dataspaces/{dataspace-name}: + get: + description: Read a dataspace given a dataspace name + operationId: getDataspace parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string + - 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: - "204": - description: No Content - content: {} + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DataspaceDetails' + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - /v1/dataspaces/{dataspace-name}/schema-sets: - post: + description: Internal Server Error + summary: Get a dataspace tags: - - cps-admin - summary: Create a schema set - description: Create a new schema set in the given dataspace - operationId: createSchemaSet + - cps-admin + /v1/dataspaces/{dataspace-name}/anchors: + post: + 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 - - name: schema-set-name - in: query - description: schema-set-name - required: true - schema: - type: string - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/MultipartFile' - required: true + - 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: + example: my-resource type: string + description: Created "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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 schema: $ref: '#/components/schemas/ErrorMessage' - /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}: - get: + description: Internal Server Error + summary: Create an anchor 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 + /v2/dataspaces/{dataspace-name}/anchors: + post: + 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 - - name: schema-set-name - in: path - description: schema-set-name - required: true - schema: - type: string + - 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: - "200": - description: OK + "201": + description: Created without response body + "400": content: application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid schema: - $ref: '#/components/schemas/SchemaSetDetails' - "400": + $ref: '#/components/schemas/ErrorMessage' description: Bad Request + "401": content: application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' - "401": description: Unauthorized + "403": content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "403": 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' - "404": - description: The specified resource was not found + description: Conflict + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - delete: + description: Internal Server Error + summary: Create an anchor tags: - - cps-admin - summary: Delete a schema set - description: Delete a schema set given a schema set name and a dataspace - operationId: deleteSchemaSet + - cps-admin + /{apiVersion}/dataspaces/{dataspace-name}/anchors: + get: + description: "Read all anchors, given a dataspace" + operationId: getAnchors parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: schema-set-name - in: path - description: schema-set-name - required: true - schema: - type: string + - 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: - "204": - description: No Content - content: {} + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AnchorDetails' + type: array + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "409": - description: Conflict + description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: - get: + description: Internal Server Error + summary: Get anchors tags: - - cps-data - summary: Get a node + - cps-admin + /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}: + delete: + description: Delete an anchor given an anchor name and a dataspace + operationId: deleteAnchor + parameters: + - 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": + content: {} + description: No Content + "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Delete an anchor + tags: + - cps-admin + get: + description: Read an anchor given an anchor name and a dataspace + operationId: getAnchor + parameters: + - 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": + content: + application/json: + schema: + $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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Get an anchor + tags: + - cps-admin + /v1/dataspaces/{dataspace-name}/schema-sets: + post: + deprecated: true + description: Create a new schema set in the given dataspace + operationId: createSchemaSet + parameters: + - 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: + schema: + $ref: '#/components/schemas/MultipartFile' + required: true + responses: + "201": + content: + text/plain: + schema: + example: my-resource + type: string + description: Created + "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a schema set + tags: + - cps-admin + /v2/dataspaces/{dataspace-name}/schema-sets: + post: + description: Create a new schema set in the given dataspace + operationId: createSchemaSetV2 + parameters: + - 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: + schema: + $ref: '#/components/schemas/MultipartFile' + required: true + responses: + "201": + description: Created without response body + "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create a schema set + tags: + - cps-admin + /{apiVersion}/dataspaces/{dataspace-name}/schema-sets: + get: + description: "Read all schema sets, given a dataspace" + operationId: getSchemaSets + parameters: + - 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": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SchemaSetDetails' + type: array + 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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Get schema sets + tags: + - 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: + - 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": + content: {} + description: No Content + "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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 + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Delete a schema set + tags: + - cps-admin + get: + description: Read a schema set given a schema set name and a dataspace + operationId: getSchemaSet + parameters: + - 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": + content: + application/json: + schema: + $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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Get a schema set + tags: + - cps-admin + /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: + get: + 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 - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: false - schema: - type: string - default: / - - name: include-descendants - in: query - description: include-descendants - required: false - schema: - type: boolean - 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": + content: + application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null + schema: + type: object 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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Get a node + tags: + - cps-data + x-codegen-request-body-name: xpath + /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: + get: + description: Get a node with an option to retrieve all the children for a given + anchor and dataspace + operationId: getNodeByDataspaceAndAnchorV2 + parameters: + - 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." + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string + responses: + "200": content: application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null schema: type: object + description: OK + "400": + content: + application/json: example: - child: my_child - leafList: "leafListElement1, leafListElement2" - leaf: my_leaf + status: 400 + message: Bad Request + details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request + "401": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Get a node + tags: + - cps-data + x-codegen-request-body-name: xpath + /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes: + delete: + description: Delete a datanode for a given dataspace and anchor given a node + xpath. + operationId: deleteDataNode + parameters: + - 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: + "204": + content: {} + description: No Content "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Delete a data node + tags: + - 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: + - 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: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + required: true + responses: + "200": content: application/json: + examples: + dataSample: + value: "" + schema: + type: object + 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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' description: Unauthorized + "403": content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "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 + summary: Update node leaves + tags: + - cps-data + post: + description: Create a node for a given anchor and dataspace + operationId: createNode + parameters: + - 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 + responses: + "201": + content: + text/plain: + schema: + example: my-resource + type: string + description: Created + "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": + content: + application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + 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' - "404": - description: The specified resource was not found + description: Conflict + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - x-codegen-request-body-name: xpath - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes: - put: + description: Internal Server Error + summary: Create a node tags: - - cps-data - summary: Replace a node with descendants + - cps-data + put: description: "Replace a node with descendants for a given dataspace, anchor\ \ and a parent node xpath" operationId: replaceNode parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: false - schema: - type: string - default: / - - 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: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null schema: - type: string + type: object required: true responses: "200": - description: OK content: application/json: + examples: + dataSample: + value: "" schema: type: object - example: - key: value + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - post: + description: Internal Server Error + summary: Replace a node with descendants tags: - - cps-data - summary: Create a node - description: Create a node for a given anchor and dataspace - operationId: createNode + - cps-data + /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: + delete: + 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 - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: false - schema: - type: string - default: / - - 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: string - required: true + - 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: - "201": - description: Created + "204": + content: {} + description: No Content + "400": content: - text/plain: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid schema: - type: string - "400": + $ref: '#/components/schemas/ErrorMessage' description: Bad Request + "401": content: application/json: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' - "401": description: Unauthorized + "403": content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "403": description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - patch: + description: Internal Server Error + summary: Delete one or all list element(s) tags: - - cps-data - summary: Update node leaves - description: Update a data node leaves for a given dataspace and anchor and - a parent node xpath - operationId: updateNodeLeaves + - 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: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: false - schema: - type: string - default: / - - 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: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null schema: - type: string + type: object required: true responses: - "200": - description: OK + "201": content: - application/json: + text/plain: schema: - type: object - example: - key: value + example: my-resource + type: string + description: Created "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: - put: + description: Internal Server Error + summary: Add list element(s) tags: - - cps-data - summary: Replace list-node child element(s) under existing parent node - description: Replace list-node child elements under existing node for a given - anchor and dataspace - operationId: replaceListNodeElements + - cps-data + put: + description: "Replace list content under a given parent, anchor and dataspace" + operationId: replaceListContent parameters: - - name: dataspace-name - in: path - description: dataspace-name - required: true - schema: - type: string - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: true - schema: - type: string - - 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: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null schema: - type: string + type: object required: true responses: "200": - description: Created content: - text/plain: + application/json: + examples: + dataSample: + value: "" schema: - type: string + type: object + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - post: + description: Internal Server Error + summary: Replace list content tags: - - cps-data - summary: Add list-node child element(s) under existing parent node - description: Add list-node child elements to existing node for a given anchor - and dataspace - operationId: addListNodeElements + - cps-data + /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: + get: + 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 - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: true - schema: - type: string - - 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: string - required: true + - 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: - "201": - description: Created + "200": content: - text/plain: + application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null schema: - type: string + type: object + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - delete: + description: Internal Server Error + summary: Query data nodes tags: - - cps-data - summary: Delete list-node child element(s) under existing parent node - description: Delete list-node child elements under existing node for a given - anchor and dataspace - operationId: deleteListNodeElements + - cps-query + x-codegen-request-body-name: xpath + /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: + get: + 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 - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: xpath - in: query - description: xpath - required: true - schema: - type: string - - 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 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." + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string responses: - "204": - description: No Content - content: {} + "200": + content: + application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSample' + value: null + schema: + type: object + description: OK "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' description: Forbidden + "500": content: application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred schema: $ref: '#/components/schemas/ErrorMessage' - /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: - get: - tags: - - cps-query + description: Internal Server Error summary: Query data nodes - description: Query data nodes for the given dataspace and anchor using CPS path - operationId: getNodesByDataspaceAndAnchorAndCpsPath + tags: + - cps-query + x-codegen-request-body-name: xpath + /v2/dataspaces/{dataspace-name}/nodes/query: + get: + 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 - - name: anchor-name - in: path - description: anchor-name - required: true - schema: - type: string - - name: cps-path - in: query - description: cps-path - required: false - schema: - type: string - default: / - - name: include-descendants - in: query - description: include-descendants - required: false - schema: - type: boolean - default: false + - 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." + in: query + name: descendants + required: false + schema: + default: none + example: "3" + type: string + - description: "page index for pagination over anchors" + name: pageIndex + in: query + required: false + schema: + type: integer + minimum: 1 + - description: "number of records (anchors) to query per page" + name: pageSize + in: query + required: false + schema: + type: integer + minimum: 1 responses: "200": - description: OK content: application/json: + examples: + dataSample: + $ref: '#/components/examples/dataSampleAcrossAnchors' + value: null schema: type: object - example: - key: value + description: OK + headers: + total-pages: + schema: + type: integer + description: Total number of pages for given page size "400": - description: Bad Request 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: + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized schema: $ref: '#/components/schemas/ErrorMessage' + description: Unauthorized "403": - description: Forbidden content: application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + description: Forbidden + "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 + summary: Query data nodes + tags: + - cps-query x-codegen-request-body-name: xpath components: + examples: + dataSample: + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: 1 + name: SciFi + - code: 2 + name: kids + dataSampleXml: + value: + Chapters 1 SciFi + + 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: + description: dataspace-name + in: query + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + apiVersionInPath: + description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + dataspaceNameInPath: + description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + type: string + schemaSetNameInQuery: + description: schema-set-name + in: query + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string + anchorNameInQuery: + description: anchor-name + in: query + name: anchor-name + required: true + schema: + example: my-anchor + type: string + anchorNameInPath: + description: anchor-name + in: path + name: anchor-name + required: true + schema: + example: my-anchor + type: string + schemaSetNameInPath: + description: schema-set-name + in: path + name: schema-set-name + required: true + schema: + example: my-schema-set + type: string + xpathInQuery: + 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 + includeDescendantsOptionInQuery: + description: include-descendants + in: query + name: include-descendants + required: false + schema: + default: false + example: false + type: boolean + descendantsInQuery: + 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: + default: none + example: "3" + type: string + observedTimestampInQuery: + description: observed-timestamp + in: query + name: observed-timestamp + required: false + schema: + example: 2021-03-21T00:10:34.030-0100 + type: string + contentTypeHeader: + description: Content type header + in: header + name: Content-Type + required: true + schema: + example: application/json + type: string + requiredXpathInQuery: + 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 + 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 + 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: - title: Error - type: object properties: status: type: string - example: "400" message: type: string - example: Dataspace not found details: type: string - example: Dataspace with name D1 does not exist. - AnchorDetails: - title: Anchor details by anchor Name + 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 - example: my_anchor dataspaceName: + example: my-dataspace type: string - example: my_dataspace schemaSetName: + example: my-schema-set type: string - example: my_schema_set - MultipartFile: - required: - - file + title: Anchor details by anchor Name type: object + MultipartFile: properties: file: - type: string description: multipartFile + example: !!binary |- + aHR0cHM6Ly9naXRodWIuY29tL29uYXAvY3BzL2Jsb2IvbWFzdGVyL2Nwcy1zZXJ2aWNlL3NyYy90 + ZXN0L3Jlc291cmNlcy9ib29rc3RvcmUueWFuZw== format: binary - SchemaSetDetails: - title: Schema set details by dataspace and schemasetName + 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 - example: my_dataspace moduleReferences: - type: array items: $ref: '#/components/schemas/ModuleReferences' + type: array name: + example: my-schema-set type: string - example: my_schema_set - ModuleReferences: - title: Module reference object + 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 - example: module_reference_name namespace: + example: my-module-reference-namespace type: string - example: module_reference_namespace revision: + example: my-module-reference-revision type: string - example: module_reference_revision + title: Module reference object + type: object + securitySchemes: + basicAuth: + scheme: basic + type: http \ No newline at end of file