3 title: ONAP Open API v3 Configuration Persistence Service
4 description: Configuration Persistence Service is a Model Driven Generic Database
8 url: 'https://onap.readthedocs.io'
9 email: onap-discuss@lists.onap.org
12 url: 'http://www.apache.org/licenses/LICENSE-2.0'
13 x-planned-retirement-date: '202212'
18 - url: '//localhost:8088'
21 description: cps Admin
27 description: Create a new dataspace
30 summary: Create a dataspace
31 operationId: createDataspace
33 - name: dataspace-name
35 description: dataspace-name
47 description: Bad Request
51 $ref: '#/components/schemas/ErrorMessage'
53 description: Unauthorized
57 $ref: '#/components/schemas/ErrorMessage'
59 description: Forbidden
63 $ref: '#/components/schemas/ErrorMessage'
64 '/v1/dataspaces/{dataspace-name}':
66 description: Delete the given dataspace - DRAFT
69 summary: Delete a dataspace
70 operationId: deleteDataspace
72 - name: dataspace-name
74 description: dataspace-name
86 description: No Content
89 description: Bad Request
93 $ref: '#/components/schemas/ErrorMessage'
95 description: Unauthorized
99 $ref: '#/components/schemas/ErrorMessage'
101 description: Forbidden
105 $ref: '#/components/schemas/ErrorMessage'
106 '/v1/dataspaces/{dataspace-name}/anchors':
108 description: 'Read all anchors, given a dataspace'
112 operationId: getAnchors
114 - name: dataspace-name
116 description: dataspace-name
128 description: Bad Request
132 $ref: '#/components/schemas/ErrorMessage'
134 description: Unauthorized
138 $ref: '#/components/schemas/ErrorMessage'
140 description: Forbidden
144 $ref: '#/components/schemas/ErrorMessage'
146 description: The specified resource was not found
150 $ref: '#/components/schemas/ErrorMessage'
152 description: Create a new anchor in the given dataspace
155 summary: Create an anchor
156 operationId: createAnchor
158 - name: dataspace-name
160 description: dataspace-name
164 - name: schema-set-name
166 description: schema-set-name
172 description: anchor-name
184 description: Bad Request
188 $ref: '#/components/schemas/ErrorMessage'
190 description: Unauthorized
194 $ref: '#/components/schemas/ErrorMessage'
196 description: Forbidden
200 $ref: '#/components/schemas/ErrorMessage'
201 '/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}':
203 description: Read an anchor given an anchor name and a dataspace
206 summary: Get an anchor
207 operationId: getAnchor
209 - name: dataspace-name
211 description: dataspace-name
217 description: anchor-name
229 description: Bad Request
233 $ref: '#/components/schemas/ErrorMessage'
235 description: Unauthorized
239 $ref: '#/components/schemas/ErrorMessage'
241 description: Forbidden
245 $ref: '#/components/schemas/ErrorMessage'
247 description: The specified resource was not found
251 $ref: '#/components/schemas/ErrorMessage'
253 description: Delete an anchor given an anchor name and a dataspace - DRAFT
256 summary: Delete an anchor
257 operationId: deleteAnchor
259 - name: dataspace-name
261 description: dataspace-name
267 description: anchor-name
279 description: No Content
282 description: Bad Request
286 $ref: '#/components/schemas/ErrorMessage'
288 description: Unauthorized
292 $ref: '#/components/schemas/ErrorMessage'
294 description: Forbidden
298 $ref: '#/components/schemas/ErrorMessage'
299 '/v1/dataspaces/{dataspace-name}/schema-sets':
301 description: Create a new schema set in the given dataspace
304 summary: Create a schema set
305 operationId: createSchemaSet
307 - name: dataspace-name
309 description: dataspace-name
313 - name: schema-set-name
315 description: schema-set-name
329 description: multipartFile
331 example: 'http://example.com/examples/example.yang'
340 description: Bad Request
344 $ref: '#/components/schemas/ErrorMessage'
346 description: Unauthorized
350 $ref: '#/components/schemas/ErrorMessage'
352 description: Forbidden
356 $ref: '#/components/schemas/ErrorMessage'
357 '/v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}':
359 description: Read a schema set given a schema set name and a dataspace
362 summary: Get a schema set
363 operationId: getSchemaSet
365 - name: dataspace-name
367 description: dataspace-name
371 - name: schema-set-name
373 description: schema-set-name
385 description: Bad Request
389 $ref: '#/components/schemas/ErrorMessage'
391 description: Unauthorized
395 $ref: '#/components/schemas/ErrorMessage'
397 description: Forbidden
401 $ref: '#/components/schemas/ErrorMessage'
403 description: The specified resource was not found
407 $ref: '#/components/schemas/ErrorMessage'
409 description: Delete a schema set given a schema set name and a dataspace
412 summary: Delete a schema set
413 operationId: deleteSchemaSet
415 - name: dataspace-name
417 description: dataspace-name
421 - name: schema-set-name
423 description: schema-set-name
429 description: No Content
432 description: Bad Request
436 $ref: '#/components/schemas/ErrorMessage'
438 description: Unauthorized
442 $ref: '#/components/schemas/ErrorMessage'
444 description: Forbidden
448 $ref: '#/components/schemas/ErrorMessage'
450 description: Conflict
454 $ref: '#/components/schemas/ErrorMessage'
455 '/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node':
458 Get a node with an option to retrieve all the children for a given
463 operationId: getNodeByDataspaceAndAnchor
465 - name: dataspace-name
467 description: dataspace-name
473 description: anchor-name
484 - name: include-descendants
486 description: include-descendants
499 description: Bad Request
503 $ref: '#/components/schemas/ErrorMessage'
505 description: Unauthorized
509 $ref: '#/components/schemas/ErrorMessage'
511 description: Forbidden
515 $ref: '#/components/schemas/ErrorMessage'
517 description: The specified resource was not found
521 $ref: '#/components/schemas/ErrorMessage'
522 x-codegen-request-body-name: xpath
523 '/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes':
525 description: Create a node for a given anchor and dataspace
528 summary: Create a node
529 operationId: createNode
531 - name: dataspace-name
533 description: dataspace-name
539 description: anchor-name
557 description: Bad Request
561 $ref: '#/components/schemas/ErrorMessage'
563 description: Unauthorized
567 $ref: '#/components/schemas/ErrorMessage'
569 description: Forbidden
573 $ref: '#/components/schemas/ErrorMessage'
576 Update a data node leaves for a given dataspace and anchor and a parent
580 summary: Update node leaves
581 operationId: updateNodeLeaves
583 - name: dataspace-name
585 description: dataspace-name
591 description: anchor-name
616 description: Bad Request
620 $ref: '#/components/schemas/ErrorMessage'
622 description: Unauthorized
626 $ref: '#/components/schemas/ErrorMessage'
628 description: Forbidden
632 $ref: '#/components/schemas/ErrorMessage'
635 Replace a node with descendants for a given dataspace, anchor and a
639 summary: Replace a node with descendants
640 operationId: replaceNode
642 - name: dataspace-name
644 description: dataspace-name
650 description: anchor-name
675 description: Bad Request
679 $ref: '#/components/schemas/ErrorMessage'
681 description: Unauthorized
685 $ref: '#/components/schemas/ErrorMessage'
687 description: Forbidden
691 $ref: '#/components/schemas/ErrorMessage'
692 '/v1/dataspaces/{dataspace-name}/nodes':
695 Get all nodes for a given dataspace using an xpath or schema node
700 operationId: getNodesByDataspace
702 - name: dataspace-name
704 description: dataspace-name
716 description: Bad Request
720 $ref: '#/components/schemas/ErrorMessage'
722 description: Unauthorized
726 $ref: '#/components/schemas/ErrorMessage'
728 description: Forbidden
732 $ref: '#/components/schemas/ErrorMessage'
734 description: The specified resource was not found
738 $ref: '#/components/schemas/ErrorMessage'
739 x-codegen-request-body-name: requestBody
740 '/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query':
742 description: Query data nodes for the given dataspace and anchor using CPS path
745 summary: Query data nodes
746 operationId: getNodesByDataspaceAndAnchorAndCpsPath
748 - name: dataspace-name
750 description: dataspace-name
756 description: anchor-name
762 description: cps-path
775 description: Bad Request
779 $ref: '#/components/schemas/ErrorMessage'
781 description: Unauthorized
785 $ref: '#/components/schemas/ErrorMessage'
787 description: Forbidden
791 $ref: '#/components/schemas/ErrorMessage'
793 description: The specified resource was not found
797 $ref: '#/components/schemas/ErrorMessage'
798 x-codegen-request-body-name: xpath
810 example: Dataspace not found
813 example: Dataspace with name D1 does not exist.