summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/openapi/cpsAdmin.yml
diff options
context:
space:
mode:
authoregernug <gerard.nugent@est.tech>2024-09-18 13:32:19 +0100
committeregernug <gerard.nugent@est.tech>2024-09-18 16:16:29 +0100
commitb76392e2d1629d4eb67b10c450cdd954ef678966 (patch)
tree040f4529c26c989629e5786568e22d9bb0c0d583 /cps-rest/docs/openapi/cpsAdmin.yml
parent03d2e8607ecfa0502ea93335243c56752ee66f92 (diff)
[1/2] Move Swagger API to docs folder
Code generation moved to docs folder for cps-core Issue-ID: CPS-2332 Change-Id: I9a8c5007a3039e0f46114c589de0756d6de91127 Signed-off-by: egernug <gerard.nugent@est.tech>
Diffstat (limited to 'cps-rest/docs/openapi/cpsAdmin.yml')
-rw-r--r--cps-rest/docs/openapi/cpsAdmin.yml232
1 files changed, 0 insertions, 232 deletions
diff --git a/cps-rest/docs/openapi/cpsAdmin.yml b/cps-rest/docs/openapi/cpsAdmin.yml
deleted file mode 100644
index f394270dd5..0000000000
--- a/cps-rest/docs/openapi/cpsAdmin.yml
+++ /dev/null
@@ -1,232 +0,0 @@
-# ============LICENSE_START=======================================================
-# Copyright (c) 2021 Bell Canada.
-# Modifications Copyright (C) 2021-2022 Nordix Foundation
-# Modifications Copyright (C) 2022 TechMahindra Ltd.
-# ================================================================================
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# SPDX-License-Identifier: Apache-2.0
-# ============LICENSE_END=========================================================
-
-dataspaces:
- delete:
- description: Delete a dataspace
- tags:
- - cps-admin
- summary: Delete a dataspace
- operationId: deleteDataspace
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInQuery'
- responses:
- '204':
- $ref: 'components.yml#/components/responses/NoContent'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '409':
- $ref: 'components.yml#/components/responses/Conflict'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-schemaSet:
- get:
- description: Read all schema sets, given a dataspace
- tags:
- - cps-admin
- summary: Get schema sets
- operationId: getSchemaSets
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: 'components.yml#/components/schemas/SchemaSetDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-schemaSetBySchemaSetName:
- get:
- description: Read a schema set given a schema set name and a dataspace
- tags:
- - cps-admin
- summary: Get a schema set
- operationId: getSchemaSet
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: 'components.yml#/components/schemas/SchemaSetDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
- delete:
- description: Delete a schema set given a schema set name and a dataspace
- tags:
- - cps-admin
- summary: Delete a schema set
- operationId: deleteSchemaSet
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- - $ref: 'components.yml#/components/parameters/schemaSetNameInPath'
- responses:
- '204':
- $ref: 'components.yml#/components/responses/NoContent'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '409':
- $ref: 'components.yml#/components/responses/Conflict'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-anchorsByDataspace:
- get:
- description: Read all anchors, given a dataspace
- tags:
- - cps-admin
- summary: Get anchors
- operationId: getAnchors
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: 'components.yml#/components/schemas/AnchorDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-anchorByDataspaceAndAnchorName:
- get:
- description: Read an anchor given an anchor name and a dataspace
- tags:
- - cps-admin
- summary: Get an anchor
- operationId: getAnchor
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- - $ref: 'components.yml#/components/parameters/anchorNameInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: 'components.yml#/components/schemas/AnchorDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
- delete:
- description: Delete an anchor given an anchor name and a dataspace
- tags:
- - cps-admin
- summary: Delete an anchor
- operationId: deleteAnchor
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- - $ref: 'components.yml#/components/parameters/anchorNameInPath'
- responses:
- '204':
- $ref: 'components.yml#/components/responses/NoContent'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-adminDataspaces:
- get:
- description: Read all dataspaces
- tags:
- - cps-admin
- summary: Get all dataspaces
- operationId: getAllDataspaces
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: 'components.yml#/components/schemas/DataspaceDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'
-
-adminDataspace:
- get:
- description: Read a dataspace given a dataspace name
- tags:
- - cps-admin
- summary: Get a dataspace
- operationId: getDataspace
- parameters:
- - $ref: 'components.yml#/components/parameters/apiVersionInPath'
- - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: 'components.yml#/components/schemas/DataspaceDetails'
- '400':
- $ref: 'components.yml#/components/responses/BadRequest'
- '403':
- $ref: 'components.yml#/components/responses/Forbidden'
- '500':
- $ref: 'components.yml#/components/responses/InternalServerError'