X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi%2Fswagger%2Fcps%2Fopenapi.yaml;h=983252f5af9d32ea85ee4838e7bc6b42b67cd59b;hb=a1129b696f3197fc7d8a3b63bcd84b5b2dd8874e;hp=fb219eb6523fbfc95dd01ad2530ec53c9f4a4f14;hpb=cf2482c1fa1b7b9d9638e7c658807e8ab35069b4;p=cps.git diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index fb219eb65..983252f5a 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -36,6 +36,7 @@ paths: required: true schema: type: string + example: my-dataspace responses: "201": description: Created @@ -43,24 +44,115 @@ paths: text/plain: schema: type: string + example: my-resource + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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 + summary: Delete a dataspace + description: Delete a dataspace + operationId: deleteDataspace + parameters: + - name: dataspace-name + in: query + description: dataspace-name + required: true + schema: + type: string + example: my-dataspace + responses: + "204": + description: No Content + 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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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 /v1/dataspaces/{dataspace-name}/anchors: get: tags: @@ -75,6 +167,7 @@ paths: required: true schema: type: string + example: my-dataspace responses: "200": description: OK @@ -90,24 +183,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + example: + status: 403 + message: Request Forbidden + details: This request is 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-admin @@ -121,18 +230,21 @@ paths: 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 responses: "201": description: Created @@ -140,24 +252,57 @@ paths: text/plain: schema: type: string + example: my-resource "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}: get: tags: @@ -172,12 +317,14 @@ paths: required: true schema: type: string + example: my-dataspace - name: anchor-name in: path description: anchor-name required: true schema: type: string + example: my-anchor responses: "200": description: OK @@ -191,24 +338,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + example: + status: 403 + message: Request Forbidden + details: This request is 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 @@ -222,12 +385,14 @@ paths: required: true schema: type: string + example: my-dataspace - name: anchor-name in: path description: anchor-name required: true schema: type: string + example: my-anchor responses: "204": description: No Content @@ -238,18 +403,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred /v1/dataspaces/{dataspace-name}/schema-sets: post: tags: @@ -264,12 +451,14 @@ paths: 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 requestBody: content: multipart/form-data: @@ -283,24 +472,57 @@ paths: text/plain: schema: type: string + example: my-resource "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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 /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}: get: tags: @@ -315,12 +537,14 @@ paths: 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 responses: "200": description: OK @@ -334,24 +558,40 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + example: + status: 403 + message: Request Forbidden + details: This request is 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 @@ -365,12 +605,14 @@ paths: 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 responses: "204": description: No Content @@ -381,24 +623,50 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node: get: tags: @@ -414,25 +682,33 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 responses: "200": @@ -441,34 +717,49 @@ paths: application/json: schema: type: object - example: - child: my_child - leafList: "leafListElement1, leafListElement2" - leaf: my_leaf + examples: + dataSample: + $ref: '#/components/examples/dataSample' "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + example: + status: 403 + message: Request Forbidden + details: This request is 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 x-codegen-request-body-name: xpath /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes: put: @@ -485,19 +776,26 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -509,7 +807,10 @@ paths: content: application/json: schema: - type: string + type: object + examples: + dataSample: + $ref: '#/components/examples/dataSample' required: true responses: "200": @@ -518,26 +819,49 @@ paths: application/json: schema: type: object - example: - key: value + examples: + dataSample: + value: "" "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred post: tags: - cps-data @@ -551,19 +875,26 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -575,7 +906,10 @@ paths: content: application/json: schema: - type: string + type: object + examples: + dataSample: + $ref: '#/components/examples/dataSample' required: true responses: "201": @@ -584,24 +918,142 @@ paths: text/plain: schema: type: string + example: my-resource + "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 + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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. + "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-data + summary: Delete a data node + description: Delete a datanode for a given dataspace and anchor given a node + xpath. + operationId: deleteDataNode + 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/cps-path.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: {} "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred patch: tags: - cps-data @@ -616,19 +1068,26 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -640,7 +1099,10 @@ paths: content: application/json: schema: - type: string + type: object + examples: + dataSample: + $ref: '#/components/examples/dataSample' required: true responses: "200": @@ -649,34 +1111,56 @@ paths: application/json: schema: type: object - example: - key: value + examples: + dataSample: + value: "" "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes: put: 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 + summary: Replace list content + description: "Replace list content under a given parent, anchor and dataspace" + operationId: replaceListContent parameters: - name: dataspace-name in: path @@ -684,18 +1168,25 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -707,40 +1198,67 @@ paths: content: application/json: schema: - type: string + type: object + examples: + dataSample: + $ref: '#/components/examples/dataSample' required: true responses: "200": - description: Created + description: OK content: - text/plain: + application/json: schema: - type: string + type: object + examples: + dataSample: + value: "" "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred post: 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 + summary: Add list element(s) + description: Add list element(s) to a list for a given anchor and dataspace + operationId: addListElements parameters: - name: dataspace-name in: path @@ -748,18 +1266,25 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -771,7 +1296,10 @@ paths: content: application/json: schema: - type: string + type: object + examples: + dataSample: + $ref: '#/components/examples/dataSample' required: true responses: "201": @@ -780,31 +1308,53 @@ paths: text/plain: schema: type: string + example: my-resource "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred delete: 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 + summary: Delete one or all list element(s) + description: Delete one or all list element(s) for a given anchor and dataspace + operationId: deleteListOrListElement parameters: - name: dataspace-name in: path @@ -812,18 +1362,25 @@ paths: 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: xpath + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.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 @@ -841,18 +1398,41 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 400 + message: Bad Request + details: The provided request is not valid "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + deprecated: true /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query: get: tags: @@ -867,25 +1447,33 @@ paths: 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: cps-path + 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 responses: "200": @@ -894,32 +1482,49 @@ paths: application/json: schema: type: object - example: - key: value + examples: + dataSample: + $ref: '#/components/examples/dataSample' "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 "401": description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' + example: + status: 401 + message: Unauthorized request + details: This request is unauthorized "403": description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorMessage' - "404": - description: The specified resource was not found + example: + status: 403 + message: Request Forbidden + details: This request is 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 x-codegen-request-body-name: xpath components: schemas: @@ -929,26 +1534,23 @@ components: 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 type: object properties: name: type: string - example: my_anchor + example: my-anchor dataspaceName: type: string - example: my_dataspace + example: my-dataspace schemaSetName: type: string - example: my_schema_set + example: my-schema-set MultipartFile: required: - file @@ -960,28 +1562,40 @@ components: format: binary SchemaSetDetails: title: Schema set details by dataspace and schemasetName + required: + - moduleReferences type: object properties: dataspaceName: type: string - example: my_dataspace + example: my-dataspace moduleReferences: type: array items: $ref: '#/components/schemas/ModuleReferences' name: type: string - example: my_schema_set + example: my-schema-set ModuleReferences: title: Module reference object type: object properties: name: type: string - example: module_reference_name + example: my-module-reference-name namespace: type: string - example: module_reference_namespace + example: my-module-reference-namespace revision: type: string - example: module_reference_revision + example: my-module-reference-revision + examples: + dataSample: + value: + test:bookstore: + bookstore-name: Chapters + categories: + - code: 1 + name: SciFi + - code: 2 + name: kids