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
49 description: Bad Request
53 $ref: '#/components/schemas/ErrorMessage'
57 details: The provided request is not valid
59 description: Unauthorized
63 $ref: '#/components/schemas/ErrorMessage'
66 message: Unauthorized request
67 details: This request is unauthorized
69 description: Forbidden
73 $ref: '#/components/schemas/ErrorMessage'
76 message: Request Forbidden
77 details: This request is forbidden
83 $ref: '#/components/schemas/ErrorMessage'
86 message: Conflicting request
87 details: The request cannot be processed as the resource is in use.
89 description: Internal Server Error
93 $ref: '#/components/schemas/ErrorMessage'
96 message: Internal Server Error
97 details: Internal Server Error occurred
101 summary: Delete a dataspace
102 description: Delete a dataspace
103 operationId: deleteDataspace
105 - name: dataspace-name
107 description: dataspace-name
111 example: my-dataspace
114 description: No Content
117 description: Bad Request
121 $ref: '#/components/schemas/ErrorMessage'
125 details: The provided request is not valid
127 description: Unauthorized
131 $ref: '#/components/schemas/ErrorMessage'
134 message: Unauthorized request
135 details: This request is unauthorized
137 description: Forbidden
141 $ref: '#/components/schemas/ErrorMessage'
144 message: Request Forbidden
145 details: This request is forbidden
147 description: Conflict
151 $ref: '#/components/schemas/ErrorMessage'
154 message: Conflicting request
155 details: The request cannot be processed as the resource is in use.
157 description: Internal Server Error
161 $ref: '#/components/schemas/ErrorMessage'
164 message: Internal Server Error
165 details: Internal Server Error occurred
166 /v1/dataspaces/{dataspace-name}/anchors:
171 description: "Read all anchors, given a dataspace"
172 operationId: getAnchors
174 - name: dataspace-name
176 description: dataspace-name
180 example: my-dataspace
189 $ref: '#/components/schemas/AnchorDetails'
191 description: Bad Request
195 $ref: '#/components/schemas/ErrorMessage'
199 details: The provided request is not valid
201 description: Unauthorized
205 $ref: '#/components/schemas/ErrorMessage'
208 message: Unauthorized request
209 details: This request is unauthorized
211 description: Forbidden
215 $ref: '#/components/schemas/ErrorMessage'
218 message: Request Forbidden
219 details: This request is forbidden
221 description: Internal Server Error
225 $ref: '#/components/schemas/ErrorMessage'
228 message: Internal Server Error
229 details: Internal Server Error occurred
233 summary: Create an anchor
234 description: Create a new anchor in the given dataspace
235 operationId: createAnchor
237 - name: dataspace-name
239 description: dataspace-name
243 example: my-dataspace
244 - name: schema-set-name
246 description: schema-set-name
250 example: my-schema-set
253 description: anchor-name
267 description: Bad Request
271 $ref: '#/components/schemas/ErrorMessage'
275 details: The provided request is not valid
277 description: Unauthorized
281 $ref: '#/components/schemas/ErrorMessage'
284 message: Unauthorized request
285 details: This request is unauthorized
287 description: Forbidden
291 $ref: '#/components/schemas/ErrorMessage'
294 message: Request Forbidden
295 details: This request is forbidden
297 description: Conflict
301 $ref: '#/components/schemas/ErrorMessage'
304 message: Conflicting request
305 details: The request cannot be processed as the resource is in use.
307 description: Internal Server Error
311 $ref: '#/components/schemas/ErrorMessage'
314 message: Internal Server Error
315 details: Internal Server Error occurred
316 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}:
320 summary: Get an anchor
321 description: Read an anchor given an anchor name and a dataspace
322 operationId: getAnchor
324 - name: dataspace-name
326 description: dataspace-name
330 example: my-dataspace
333 description: anchor-name
344 $ref: '#/components/schemas/AnchorDetails'
346 description: Bad Request
350 $ref: '#/components/schemas/ErrorMessage'
354 details: The provided request is not valid
356 description: Unauthorized
360 $ref: '#/components/schemas/ErrorMessage'
363 message: Unauthorized request
364 details: This request is unauthorized
366 description: Forbidden
370 $ref: '#/components/schemas/ErrorMessage'
373 message: Request Forbidden
374 details: This request is forbidden
376 description: Internal Server Error
380 $ref: '#/components/schemas/ErrorMessage'
383 message: Internal Server Error
384 details: Internal Server Error occurred
388 summary: Delete an anchor
389 description: Delete an anchor given an anchor name and a dataspace
390 operationId: deleteAnchor
392 - name: dataspace-name
394 description: dataspace-name
398 example: my-dataspace
401 description: anchor-name
408 description: No Content
411 description: Bad Request
415 $ref: '#/components/schemas/ErrorMessage'
419 details: The provided request is not valid
421 description: Unauthorized
425 $ref: '#/components/schemas/ErrorMessage'
428 message: Unauthorized request
429 details: This request is unauthorized
431 description: Forbidden
435 $ref: '#/components/schemas/ErrorMessage'
438 message: Request Forbidden
439 details: This request is forbidden
441 description: Internal Server Error
445 $ref: '#/components/schemas/ErrorMessage'
448 message: Internal Server Error
449 details: Internal Server Error occurred
450 /v1/dataspaces/{dataspace-name}/schema-sets:
454 summary: Create a schema set
455 description: Create a new schema set in the given dataspace
456 operationId: createSchemaSet
458 - name: dataspace-name
460 description: dataspace-name
464 example: my-dataspace
465 - name: schema-set-name
467 description: schema-set-name
471 example: my-schema-set
476 $ref: '#/components/schemas/MultipartFile'
487 description: Bad Request
491 $ref: '#/components/schemas/ErrorMessage'
495 details: The provided request is not valid
497 description: Unauthorized
501 $ref: '#/components/schemas/ErrorMessage'
504 message: Unauthorized request
505 details: This request is unauthorized
507 description: Forbidden
511 $ref: '#/components/schemas/ErrorMessage'
514 message: Request Forbidden
515 details: This request is forbidden
517 description: Conflict
521 $ref: '#/components/schemas/ErrorMessage'
524 message: Conflicting request
525 details: The request cannot be processed as the resource is in use.
527 description: Internal Server Error
531 $ref: '#/components/schemas/ErrorMessage'
534 message: Internal Server Error
535 details: Internal Server Error occurred
536 /v1/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
540 summary: Get a schema set
541 description: Read a schema set given a schema set name and a dataspace
542 operationId: getSchemaSet
544 - name: dataspace-name
546 description: dataspace-name
550 example: my-dataspace
551 - name: schema-set-name
553 description: schema-set-name
557 example: my-schema-set
564 $ref: '#/components/schemas/SchemaSetDetails'
566 description: Bad Request
570 $ref: '#/components/schemas/ErrorMessage'
574 details: The provided request is not valid
576 description: Unauthorized
580 $ref: '#/components/schemas/ErrorMessage'
583 message: Unauthorized request
584 details: This request is unauthorized
586 description: Forbidden
590 $ref: '#/components/schemas/ErrorMessage'
593 message: Request Forbidden
594 details: This request is forbidden
596 description: Internal Server Error
600 $ref: '#/components/schemas/ErrorMessage'
603 message: Internal Server Error
604 details: Internal Server Error occurred
608 summary: Delete a schema set
609 description: Delete a schema set given a schema set name and a dataspace
610 operationId: deleteSchemaSet
612 - name: dataspace-name
614 description: dataspace-name
618 example: my-dataspace
619 - name: schema-set-name
621 description: schema-set-name
625 example: my-schema-set
628 description: No Content
631 description: Bad Request
635 $ref: '#/components/schemas/ErrorMessage'
639 details: The provided request is not valid
641 description: Unauthorized
645 $ref: '#/components/schemas/ErrorMessage'
648 message: Unauthorized request
649 details: This request is unauthorized
651 description: Forbidden
655 $ref: '#/components/schemas/ErrorMessage'
658 message: Request Forbidden
659 details: This request is forbidden
661 description: Conflict
665 $ref: '#/components/schemas/ErrorMessage'
668 message: Conflicting request
669 details: The request cannot be processed as the resource is in use.
671 description: Internal Server Error
675 $ref: '#/components/schemas/ErrorMessage'
678 message: Internal Server Error
679 details: Internal Server Error occurred
680 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
685 description: Get a node with an option to retrieve all the children for a given
687 operationId: getNodeByDataspaceAndAnchor
689 - name: dataspace-name
691 description: dataspace-name
695 example: my-dataspace
698 description: anchor-name
705 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
712 value: /shops/bookstore
713 list attributes xpath:
714 value: "/shops/bookstore/categories[@code=1]"
715 - name: include-descendants
717 description: include-descendants
732 $ref: '#/components/examples/dataSample'
734 description: Bad Request
738 $ref: '#/components/schemas/ErrorMessage'
742 details: The provided request is not valid
744 description: Unauthorized
748 $ref: '#/components/schemas/ErrorMessage'
751 message: Unauthorized request
752 details: This request is unauthorized
754 description: Forbidden
758 $ref: '#/components/schemas/ErrorMessage'
761 message: Request Forbidden
762 details: This request is forbidden
764 description: Internal Server Error
768 $ref: '#/components/schemas/ErrorMessage'
771 message: Internal Server Error
772 details: Internal Server Error occurred
773 x-codegen-request-body-name: xpath
774 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
778 summary: Replace a node with descendants
779 description: "Replace a node with descendants for a given dataspace, anchor\
780 \ and a parent node xpath"
781 operationId: replaceNode
783 - name: dataspace-name
785 description: dataspace-name
789 example: my-dataspace
792 description: anchor-name
799 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
806 value: /shops/bookstore
807 list attributes xpath:
808 value: "/shops/bookstore/categories[@code=1]"
809 - name: observed-timestamp
811 description: observed-timestamp
815 example: 2021-03-21T00:10:34.030-0100
823 $ref: '#/components/examples/dataSample'
836 description: Bad Request
840 $ref: '#/components/schemas/ErrorMessage'
844 details: The provided request is not valid
846 description: Unauthorized
850 $ref: '#/components/schemas/ErrorMessage'
853 message: Unauthorized request
854 details: This request is unauthorized
856 description: Forbidden
860 $ref: '#/components/schemas/ErrorMessage'
863 message: Request Forbidden
864 details: This request is forbidden
866 description: Internal Server Error
870 $ref: '#/components/schemas/ErrorMessage'
873 message: Internal Server Error
874 details: Internal Server Error occurred
878 summary: Create a node
879 description: Create a node for a given anchor and dataspace
880 operationId: createNode
882 - name: dataspace-name
884 description: dataspace-name
888 example: my-dataspace
891 description: anchor-name
898 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
905 value: /shops/bookstore
906 list attributes xpath:
907 value: "/shops/bookstore/categories[@code=1]"
908 - name: observed-timestamp
910 description: observed-timestamp
914 example: 2021-03-21T00:10:34.030-0100
922 $ref: '#/components/examples/dataSample'
933 description: Bad Request
937 $ref: '#/components/schemas/ErrorMessage'
941 details: The provided request is not valid
943 description: Unauthorized
947 $ref: '#/components/schemas/ErrorMessage'
950 message: Unauthorized request
951 details: This request is unauthorized
953 description: Forbidden
957 $ref: '#/components/schemas/ErrorMessage'
960 message: Request Forbidden
961 details: This request is forbidden
963 description: Conflict
967 $ref: '#/components/schemas/ErrorMessage'
970 message: Conflicting request
971 details: The request cannot be processed as the resource is in use.
973 description: Internal Server Error
977 $ref: '#/components/schemas/ErrorMessage'
980 message: Internal Server Error
981 details: Internal Server Error occurred
985 summary: Delete a data node
986 description: Delete a datanode for a given dataspace and anchor given a node
988 operationId: deleteDataNode
990 - name: dataspace-name
992 description: dataspace-name
996 example: my-dataspace
999 description: anchor-name
1006 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1013 value: /shops/bookstore
1014 list attributes xpath:
1015 value: "/shops/bookstore/categories[@code=1]"
1016 - name: observed-timestamp
1018 description: observed-timestamp
1022 example: 2021-03-21T00:10:34.030-0100
1025 description: No Content
1028 description: Bad Request
1032 $ref: '#/components/schemas/ErrorMessage'
1035 message: Bad Request
1036 details: The provided request is not valid
1038 description: Unauthorized
1042 $ref: '#/components/schemas/ErrorMessage'
1045 message: Unauthorized request
1046 details: This request is unauthorized
1048 description: Forbidden
1052 $ref: '#/components/schemas/ErrorMessage'
1055 message: Request Forbidden
1056 details: This request is forbidden
1058 description: Internal Server Error
1062 $ref: '#/components/schemas/ErrorMessage'
1065 message: Internal Server Error
1066 details: Internal Server Error occurred
1070 summary: Update node leaves
1071 description: Update a data node leaves for a given dataspace and anchor and
1073 operationId: updateNodeLeaves
1075 - name: dataspace-name
1077 description: dataspace-name
1081 example: my-dataspace
1084 description: anchor-name
1091 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1098 value: /shops/bookstore
1099 list attributes xpath:
1100 value: "/shops/bookstore/categories[@code=1]"
1101 - name: observed-timestamp
1103 description: observed-timestamp
1107 example: 2021-03-21T00:10:34.030-0100
1115 $ref: '#/components/examples/dataSample'
1128 description: Bad Request
1132 $ref: '#/components/schemas/ErrorMessage'
1135 message: Bad Request
1136 details: The provided request is not valid
1138 description: Unauthorized
1142 $ref: '#/components/schemas/ErrorMessage'
1145 message: Unauthorized request
1146 details: This request is unauthorized
1148 description: Forbidden
1152 $ref: '#/components/schemas/ErrorMessage'
1155 message: Request Forbidden
1156 details: This request is forbidden
1158 description: Internal Server Error
1162 $ref: '#/components/schemas/ErrorMessage'
1165 message: Internal Server Error
1166 details: Internal Server Error occurred
1167 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1171 summary: Replace list content
1172 description: "Replace list content under a given parent, anchor and dataspace"
1173 operationId: replaceListContent
1175 - name: dataspace-name
1177 description: dataspace-name
1181 example: my-dataspace
1184 description: anchor-name
1191 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1197 value: /shops/bookstore
1198 list attributes xpath:
1199 value: "/shops/bookstore/categories[@code=1]"
1200 - name: observed-timestamp
1202 description: observed-timestamp
1206 example: 2021-03-21T00:10:34.030-0100
1214 $ref: '#/components/examples/dataSample'
1227 description: Bad Request
1231 $ref: '#/components/schemas/ErrorMessage'
1234 message: Bad Request
1235 details: The provided request is not valid
1237 description: Unauthorized
1241 $ref: '#/components/schemas/ErrorMessage'
1244 message: Unauthorized request
1245 details: This request is unauthorized
1247 description: Forbidden
1251 $ref: '#/components/schemas/ErrorMessage'
1254 message: Request Forbidden
1255 details: This request is forbidden
1257 description: Internal Server Error
1261 $ref: '#/components/schemas/ErrorMessage'
1264 message: Internal Server Error
1265 details: Internal Server Error occurred
1269 summary: Add list element(s)
1270 description: Add list element(s) to a list for a given anchor and dataspace
1271 operationId: addListElements
1273 - name: dataspace-name
1275 description: dataspace-name
1279 example: my-dataspace
1282 description: anchor-name
1289 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1295 value: /shops/bookstore
1296 list attributes xpath:
1297 value: "/shops/bookstore/categories[@code=1]"
1298 - name: observed-timestamp
1300 description: observed-timestamp
1304 example: 2021-03-21T00:10:34.030-0100
1312 $ref: '#/components/examples/dataSample'
1316 description: Created
1321 example: my-resource
1323 description: Bad Request
1327 $ref: '#/components/schemas/ErrorMessage'
1330 message: Bad Request
1331 details: The provided request is not valid
1333 description: Unauthorized
1337 $ref: '#/components/schemas/ErrorMessage'
1340 message: Unauthorized request
1341 details: This request is unauthorized
1343 description: Forbidden
1347 $ref: '#/components/schemas/ErrorMessage'
1350 message: Request Forbidden
1351 details: This request is forbidden
1353 description: Internal Server Error
1357 $ref: '#/components/schemas/ErrorMessage'
1360 message: Internal Server Error
1361 details: Internal Server Error occurred
1365 summary: Delete one or all list element(s)
1366 description: Delete one or all list element(s) for a given anchor and dataspace
1367 operationId: deleteListOrListElement
1369 - name: dataspace-name
1371 description: dataspace-name
1375 example: my-dataspace
1378 description: anchor-name
1385 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1391 value: /shops/bookstore
1392 list attributes xpath:
1393 value: "/shops/bookstore/categories[@code=1]"
1394 - name: observed-timestamp
1396 description: observed-timestamp
1400 example: 2021-03-21T00:10:34.030-0100
1403 description: No Content
1406 description: Bad Request
1410 $ref: '#/components/schemas/ErrorMessage'
1413 message: Bad Request
1414 details: The provided request is not valid
1416 description: Unauthorized
1420 $ref: '#/components/schemas/ErrorMessage'
1423 message: Unauthorized request
1424 details: This request is unauthorized
1426 description: Forbidden
1430 $ref: '#/components/schemas/ErrorMessage'
1433 message: Request Forbidden
1434 details: This request is forbidden
1436 description: Internal Server Error
1440 $ref: '#/components/schemas/ErrorMessage'
1443 message: Internal Server Error
1444 details: Internal Server Error occurred
1446 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1450 summary: Query data nodes
1451 description: Query data nodes for the given dataspace and anchor using CPS path
1452 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1454 - name: dataspace-name
1456 description: dataspace-name
1460 example: my-dataspace
1463 description: anchor-name
1470 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
1478 list attributes cps path:
1479 value: "//categories[@code=1]"
1480 - name: include-descendants
1482 description: include-descendants
1497 $ref: '#/components/examples/dataSample'
1499 description: Bad Request
1503 $ref: '#/components/schemas/ErrorMessage'
1506 message: Bad Request
1507 details: The provided request is not valid
1509 description: Unauthorized
1513 $ref: '#/components/schemas/ErrorMessage'
1516 message: Unauthorized request
1517 details: This request is unauthorized
1519 description: Forbidden
1523 $ref: '#/components/schemas/ErrorMessage'
1526 message: Request Forbidden
1527 details: This request is forbidden
1529 description: Internal Server Error
1533 $ref: '#/components/schemas/ErrorMessage'
1536 message: Internal Server Error
1537 details: Internal Server Error occurred
1538 x-codegen-request-body-name: xpath
1556 title: Anchor details by anchor Name
1564 example: my-dataspace
1567 example: my-schema-set
1575 description: multipartFile
1578 title: Schema set details by dataspace and schemasetName
1585 example: my-dataspace
1589 $ref: '#/components/schemas/ModuleReferences'
1592 example: my-schema-set
1594 title: Module reference object
1599 example: my-module-reference-name
1602 example: my-module-reference-namespace
1605 example: my-module-reference-revision
1610 bookstore-name: Chapters