summaryrefslogtreecommitdiffstats
path: root/cps-rest/docs/openapi/openapi.yml
diff options
context:
space:
mode:
authorJosephKeenan <joseph.keenan@est.tech>2021-05-24 17:42:23 +0100
committerJosephKeenan <joseph.keenan@est.tech>2021-05-26 16:46:29 +0100
commiteef2e112d1f447b47f2f19d24e9dfd9a76550333 (patch)
tree60db7b08fa88f297433f4f13eaecee7fd4d46d97 /cps-rest/docs/openapi/openapi.yml
parent576f48e8d3ef2ac7526b5684eba0a3e8259ce3cc (diff)
Aligning differing openAPI paths (cps-rest & ncmp-rest)
Issue-ID: CPS-427 Change-Id: I1d6853419923994feed4d9c38482818f17202e36 Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
Diffstat (limited to 'cps-rest/docs/openapi/openapi.yml')
-rw-r--r--cps-rest/docs/openapi/openapi.yml58
1 files changed, 58 insertions, 0 deletions
diff --git a/cps-rest/docs/openapi/openapi.yml b/cps-rest/docs/openapi/openapi.yml
new file mode 100644
index 000000000..3c0cc09e5
--- /dev/null
+++ b/cps-rest/docs/openapi/openapi.yml
@@ -0,0 +1,58 @@
+openapi: 3.0.1
+info:
+ title: ONAP Open API v3 Configuration Persistence Service
+ description: Configuration Persistence Service is a Model Driven Generic Database
+ version: "1.0.0"
+ contact:
+ name: ONAP
+ url: "https://onap.readthedocs.io"
+ email: "onap-discuss@lists.onap.org"
+ license:
+ name: "Apache 2.0"
+ url: "http://www.apache.org/licenses/LICENSE-2.0"
+ x-planned-retirement-date: "202212"
+ x-component: "Modeling"
+ x-logo:
+ url: "cps_logo.png"
+
+servers:
+ - url: //localhost:8088
+tags:
+ - name: cps-admin
+ description: cps Admin
+ - name: cps-data
+ description: cps Data
+paths:
+
+ /v1/dataspaces:
+ $ref: 'cpsAdmin.yml#/dataspaces'
+
+ /v1/dataspaces/{dataspace-name}:
+ $ref: 'cpsAdmin.yml#/dataspaceByDataspaceName'
+
+ /v1/dataspaces/{dataspace-name}/anchors:
+ $ref: 'cpsAdmin.yml#/anchorsByDataspace'
+
+ /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
+ $ref: 'cpsAdmin.yml#/anchorByDataspaceAndAnchorName'
+
+ /v1/dataspaces/{dataspace-name}/schema-sets:
+ $ref: 'cpsAdmin.yml#/schemaSet'
+
+ /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
+ $ref: 'cpsAdmin.yml#/schemaSetBySchemaSetName'
+
+ /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
+ $ref: 'cpsData.yml#/nodeByDataspaceAndAnchor'
+
+ /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
+ $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor'
+
+ /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-node:
+ $ref: 'cpsData.yml#/listNodeByDataspaceAndAnchor'
+
+ /v1/dataspaces/{dataspace-name}/nodes:
+ $ref: 'cpsData.yml#/nodesByDataspace'
+
+ /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
+ $ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath' \ No newline at end of file