summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
authorSourabh Sourabh <sourabh.sourabh@est.tech>2022-11-21 13:26:49 +0000
committerGerrit Code Review <gerrit@onap.org>2022-11-21 13:26:49 +0000
commit35b7b02cc26cc4fac4d2d2f15a6d38774fba1fe6 (patch)
tree9c65c50c663eb3404324dba5c17851bfcdb48c44 /docs/api
parent17cbd7b1b51f8d961ad6a908d12c767497afceb9 (diff)
parentcec0cb7254ede8a790ec6f70ad5e31d10e2d32d7 (diff)
Merge "Added get APIs for dataspace."
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/swagger/cps/openapi.yaml127
1 files changed, 126 insertions, 1 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: []