diff options
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 127 | ||||
| -rw-r--r-- | docs/api/swagger/ncmp/openapi.yaml | 12 |
2 files changed, 132 insertions, 7 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index e8f13d4df9..8ea0d7b03e 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -163,6 +163,124 @@ paths: status: 500 message: Internal Server Error details: Internal Server Error occurred + /v1/admin/dataspaces: + get: + tags: + - cps-admin + summary: Get dataspaces + description: "Read all dataspaces" + operationId: getAllDataspaces + responses: + "200": + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DataspaceDetails' + "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/admin/dataspaces/{dataspace-name}: + get: + tags: + - cps-admin + summary: Get a dataspace + description: Read an dataspace given a dataspace name + operationId: getDataspace + parameters: + - name: dataspace-name + in: path + description: dataspace-name + required: true + schema: + type: string + example: my-dataspace + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataspaceDetails' + "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: get: tags: @@ -1565,6 +1683,13 @@ components: schemaSetName: type: string example: my-schema-set + DataspaceDetails: + title: Dataspace details by dataspace Name + type: object + properties: + name: + type: string + example: my-dataspace MultipartFile: required: - file @@ -1615,4 +1740,4 @@ components: name: kids security: - - basicAuth: []
\ No newline at end of file + - basicAuth: [] diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml index b9eee5603d..44c4788cfd 100644 --- a/docs/api/swagger/ncmp/openapi.yaml +++ b/docs/api/swagger/ncmp/openapi.yaml @@ -6,7 +6,7 @@ info: servers: - url: /ncmp paths: - /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}: + /v1/ch/{cm-handle}/data/ds/{datastore-name}: get: tags: - network-cm-proxy @@ -14,7 +14,7 @@ paths: description: Get resource data for given cm handle operationId: getResourceDataForCmHandle parameters: - - name: ncmp-datastore-name + - name: datastore-name in: path description: The type of the requested data required: true @@ -154,7 +154,7 @@ paths: handle operationId: updateResourceDataRunningForCmHandle parameters: - - name: ncmp-datastore-name + - name: datastore-name in: path description: The type of the requested data required: true @@ -277,7 +277,7 @@ paths: description: create resource data from pass-through running for given cm handle operationId: createResourceDataRunningForCmHandle parameters: - - name: ncmp-datastore-name + - name: datastore-name in: path description: The type of the requested data required: true @@ -397,7 +397,7 @@ paths: description: Delete resource data from pass-through running for a given cm handle operationId: deleteResourceDataRunningForCmHandle parameters: - - name: ncmp-datastore-name + - name: datastore-name in: path description: The type of the requested data required: true @@ -513,7 +513,7 @@ paths: handle operationId: patchResourceDataRunningForCmHandle parameters: - - name: ncmp-datastore-name + - name: datastore-name in: path description: The type of the requested data required: true |