3 title: ONAP Open API v3 Configuration Persistence Service
4 description: Configuration Persistence Service is a Model Driven Generic Database
7 url: https://onap.readthedocs.io
8 email: onap-discuss@lists.onap.org
11 url: http://www.apache.org/licenses/LICENSE-2.0
13 x-planned-retirement-date: "202212"
21 description: cps Admin
29 summary: Create a dataspace
30 description: Create a new 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}/anchors:
69 description: "Read all anchors, given a dataspace"
70 operationId: getAnchors
72 - name: dataspace-name
74 description: dataspace-name
86 $ref: '#/components/schemas/AnchorDetails'
88 description: Bad Request
92 $ref: '#/components/schemas/ErrorMessage'
94 description: Unauthorized
98 $ref: '#/components/schemas/ErrorMessage'
100 description: Forbidden
104 $ref: '#/components/schemas/ErrorMessage'
106 description: The specified resource was not found
110 $ref: '#/components/schemas/ErrorMessage'
114 summary: Create an anchor
115 description: Create a new anchor in the given dataspace
116 operationId: createAnchor
118 - name: dataspace-name
120 description: dataspace-name
124 - name: schema-set-name
126 description: schema-set-name
132 description: anchor-name
144 description: Bad Request
148 $ref: '#/components/schemas/ErrorMessage'
150 description: Unauthorized
154 $ref: '#/components/schemas/ErrorMessage'
156 description: Forbidden
160 $ref: '#/components/schemas/ErrorMessage'
161 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
165 summary: Get an anchor
166 description: Read an anchor given an anchor name and a dataspace
167 operationId: getAnchor
169 - name: dataspace-name
171 description: dataspace-name
177 description: anchor-name
187 $ref: '#/components/schemas/AnchorDetails'
189 description: Bad Request
193 $ref: '#/components/schemas/ErrorMessage'
195 description: Unauthorized
199 $ref: '#/components/schemas/ErrorMessage'
201 description: Forbidden
205 $ref: '#/components/schemas/ErrorMessage'
207 description: The specified resource was not found
211 $ref: '#/components/schemas/ErrorMessage'
215 summary: Delete an anchor
216 description: Delete an anchor given an anchor name and a dataspace
217 operationId: deleteAnchor
219 - name: dataspace-name
221 description: dataspace-name
227 description: anchor-name
233 description: No Content
236 description: Bad Request
240 $ref: '#/components/schemas/ErrorMessage'
242 description: Unauthorized
246 $ref: '#/components/schemas/ErrorMessage'
248 description: Forbidden
252 $ref: '#/components/schemas/ErrorMessage'
253 /v1/dataspaces/{dataspace-name}/schema-sets:
257 summary: Create a schema set
258 description: Create a new schema set in the given dataspace
259 operationId: createSchemaSet
261 - name: dataspace-name
263 description: dataspace-name
267 - name: schema-set-name
269 description: schema-set-name
277 $ref: '#/components/schemas/MultipartFile'
287 description: Bad Request
291 $ref: '#/components/schemas/ErrorMessage'
293 description: Unauthorized
297 $ref: '#/components/schemas/ErrorMessage'
299 description: Forbidden
303 $ref: '#/components/schemas/ErrorMessage'
304 /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
308 summary: Get a schema set
309 description: Read a schema set given a schema set name and a dataspace
310 operationId: getSchemaSet
312 - name: dataspace-name
314 description: dataspace-name
318 - name: schema-set-name
320 description: schema-set-name
330 $ref: '#/components/schemas/SchemaSetDetails'
332 description: Bad Request
336 $ref: '#/components/schemas/ErrorMessage'
338 description: Unauthorized
342 $ref: '#/components/schemas/ErrorMessage'
344 description: Forbidden
348 $ref: '#/components/schemas/ErrorMessage'
350 description: The specified resource was not found
354 $ref: '#/components/schemas/ErrorMessage'
358 summary: Delete a schema set
359 description: Delete a schema set given a schema set name and a dataspace
360 operationId: deleteSchemaSet
362 - name: dataspace-name
364 description: dataspace-name
368 - name: schema-set-name
370 description: schema-set-name
376 description: No Content
379 description: Bad Request
383 $ref: '#/components/schemas/ErrorMessage'
385 description: Unauthorized
389 $ref: '#/components/schemas/ErrorMessage'
391 description: Forbidden
395 $ref: '#/components/schemas/ErrorMessage'
397 description: Conflict
401 $ref: '#/components/schemas/ErrorMessage'
402 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
407 description: Get a node with an option to retrieve all the children for a given
409 operationId: getNodeByDataspaceAndAnchor
411 - name: dataspace-name
413 description: dataspace-name
419 description: anchor-name
430 - name: include-descendants
432 description: include-descendants
446 leafList: "leafListElement1, leafListElement2"
449 description: Bad Request
453 $ref: '#/components/schemas/ErrorMessage'
455 description: Unauthorized
459 $ref: '#/components/schemas/ErrorMessage'
461 description: Forbidden
465 $ref: '#/components/schemas/ErrorMessage'
467 description: The specified resource was not found
471 $ref: '#/components/schemas/ErrorMessage'
472 x-codegen-request-body-name: xpath
473 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
477 summary: Replace a node with descendants
478 description: "Replace a node with descendants for a given dataspace, anchor\
479 \ and a parent node xpath"
480 operationId: replaceNode
482 - name: dataspace-name
484 description: dataspace-name
490 description: anchor-name
501 - name: observed-timestamp
503 description: observed-timestamp
507 example: 2021-03-21T00:10:34.030-0100
524 description: Bad Request
528 $ref: '#/components/schemas/ErrorMessage'
530 description: Unauthorized
534 $ref: '#/components/schemas/ErrorMessage'
536 description: Forbidden
540 $ref: '#/components/schemas/ErrorMessage'
544 summary: Create a node
545 description: Create a node for a given anchor and dataspace
546 operationId: createNode
548 - name: dataspace-name
550 description: dataspace-name
556 description: anchor-name
567 - name: observed-timestamp
569 description: observed-timestamp
573 example: 2021-03-21T00:10:34.030-0100
588 description: Bad Request
592 $ref: '#/components/schemas/ErrorMessage'
594 description: Unauthorized
598 $ref: '#/components/schemas/ErrorMessage'
600 description: Forbidden
604 $ref: '#/components/schemas/ErrorMessage'
608 summary: Update node leaves
609 description: Update a data node leaves for a given dataspace and anchor and
611 operationId: updateNodeLeaves
613 - name: dataspace-name
615 description: dataspace-name
621 description: anchor-name
632 - name: observed-timestamp
634 description: observed-timestamp
638 example: 2021-03-21T00:10:34.030-0100
655 description: Bad Request
659 $ref: '#/components/schemas/ErrorMessage'
661 description: Unauthorized
665 $ref: '#/components/schemas/ErrorMessage'
667 description: Forbidden
671 $ref: '#/components/schemas/ErrorMessage'
672 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
676 summary: Replace list-node child element(s) under existing parent node
677 description: Replace list-node child elements under existing node for a given
679 operationId: replaceListNodeElements
681 - name: dataspace-name
683 description: dataspace-name
689 description: anchor-name
699 - name: observed-timestamp
701 description: observed-timestamp
705 example: 2021-03-21T00:10:34.030-0100
720 description: Bad Request
724 $ref: '#/components/schemas/ErrorMessage'
726 description: Unauthorized
730 $ref: '#/components/schemas/ErrorMessage'
732 description: Forbidden
736 $ref: '#/components/schemas/ErrorMessage'
740 summary: Add list-node child element(s) under existing parent node
741 description: Add list-node child elements to existing node for a given anchor
743 operationId: addListNodeElements
745 - name: dataspace-name
747 description: dataspace-name
753 description: anchor-name
763 - name: observed-timestamp
765 description: observed-timestamp
769 example: 2021-03-21T00:10:34.030-0100
784 description: Bad Request
788 $ref: '#/components/schemas/ErrorMessage'
790 description: Unauthorized
794 $ref: '#/components/schemas/ErrorMessage'
796 description: Forbidden
800 $ref: '#/components/schemas/ErrorMessage'
804 summary: Delete list-node child element(s) under existing parent node
805 description: Delete list-node child elements under existing node for a given
807 operationId: deleteListNodeElements
809 - name: dataspace-name
811 description: dataspace-name
817 description: anchor-name
827 - name: observed-timestamp
829 description: observed-timestamp
833 example: 2021-03-21T00:10:34.030-0100
836 description: No Content
839 description: Bad Request
843 $ref: '#/components/schemas/ErrorMessage'
845 description: Unauthorized
849 $ref: '#/components/schemas/ErrorMessage'
851 description: Forbidden
855 $ref: '#/components/schemas/ErrorMessage'
856 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
860 summary: Query data nodes
861 description: Query data nodes for the given dataspace and anchor using CPS path
862 operationId: getNodesByDataspaceAndAnchorAndCpsPath
864 - name: dataspace-name
866 description: dataspace-name
872 description: anchor-name
878 description: cps-path
883 - name: include-descendants
885 description: include-descendants
900 description: Bad Request
904 $ref: '#/components/schemas/ErrorMessage'
906 description: Unauthorized
910 $ref: '#/components/schemas/ErrorMessage'
912 description: Forbidden
916 $ref: '#/components/schemas/ErrorMessage'
918 description: The specified resource was not found
922 $ref: '#/components/schemas/ErrorMessage'
923 x-codegen-request-body-name: xpath
935 example: Dataspace not found
938 example: Dataspace with name D1 does not exist.
940 title: Anchor details by anchor Name
948 example: my_dataspace
951 example: my_schema_set
959 description: multipartFile
962 title: Schema set details by dataspace and schemasetName
967 example: my_dataspace
971 $ref: '#/components/schemas/ModuleReferences'
974 example: my_schema_set
976 title: Module reference object
981 example: module_reference_name
984 example: module_reference_namespace
987 example: module_reference_revision