Replace list-node content (part 2): CPS REST layer
[cps.git] / cps-rest / docs / openapi / openapi.yml
1 openapi: 3.0.1
2 info:
3   title: ONAP Open API v3 Configuration Persistence Service
4   description: Configuration Persistence Service is a Model Driven Generic Database
5   version: "1.0.0"
6   contact:
7      name: ONAP
8      url: "https://onap.readthedocs.io"
9      email: "onap-discuss@lists.onap.org"
10   license:
11       name: "Apache 2.0"
12       url: "http://www.apache.org/licenses/LICENSE-2.0"
13   x-planned-retirement-date: "202212"
14   x-component: "Modeling"
15   x-logo:
16       url: "cps_logo.png"
17
18 servers:
19   - url: //localhost:8088
20 tags:
21   - name: cps-admin
22     description: cps Admin
23   - name: cps-data
24     description: cps Data 
25 paths:
26
27   /v1/dataspaces:
28     $ref: 'cpsAdmin.yml#/dataspaces'
29
30   /v1/dataspaces/{dataspace-name}:
31     $ref: 'cpsAdmin.yml#/dataspaceByDataspaceName'
32
33   /v1/dataspaces/{dataspace-name}/anchors:
34     $ref: 'cpsAdmin.yml#/anchorsByDataspace'
35
36   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
37     $ref: 'cpsAdmin.yml#/anchorByDataspaceAndAnchorName'
38
39   /v1/dataspaces/{dataspace-name}/schema-sets:
40     $ref: 'cpsAdmin.yml#/schemaSet'
41
42   /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
43     $ref: 'cpsAdmin.yml#/schemaSetBySchemaSetName'
44
45   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
46     $ref: 'cpsData.yml#/nodeByDataspaceAndAnchor'
47
48   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
49     $ref: 'cpsData.yml#/nodesByDataspaceAndAnchor'
50
51   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-node:
52     $ref: 'cpsData.yml#/listNodeByDataspaceAndAnchor'
53
54   /v1/dataspaces/{dataspace-name}/nodes:
55     $ref: 'cpsData.yml#/nodesByDataspace'
56
57   /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
58     $ref: 'cpsQuery.yml#/nodesByDataspaceAndAnchorAndCpsPath'