4 email: onap-discuss@lists.onap.org
6 url: https://onap.readthedocs.io
7 description: Configuration Persistence Service is a Model Driven Generic Database
10 url: http://www.apache.org/licenses/LICENSE-2.0
11 title: ONAP Open API v3 Configuration Persistence Service
13 x-planned-retirement-date: "202212"
22 - description: cps Admin
24 - description: cps Data
30 description: Create a new dataspace
31 operationId: createDataspace
33 - description: dataspace-name
54 details: The provided request is not valid
56 $ref: '#/components/schemas/ErrorMessage'
57 description: Bad Request
63 message: Request Forbidden
64 details: This request is forbidden
66 $ref: '#/components/schemas/ErrorMessage'
67 description: Forbidden
73 message: Conflicting request
74 details: The request cannot be processed as the resource is in use.
76 $ref: '#/components/schemas/ErrorMessage'
83 message: Internal Server Error
84 details: Internal Server Error occurred
86 $ref: '#/components/schemas/ErrorMessage'
87 description: Internal Server Error
88 summary: Create a dataspace
91 /{apiVersion}/dataspaces:
93 description: Delete a dataspace
94 operationId: deleteDataspace
96 - description: apiVersion
106 - description: dataspace-name
111 example: my-dataspace
116 description: No Content
123 details: The provided request is not valid
125 $ref: '#/components/schemas/ErrorMessage'
126 description: Bad Request
132 message: Request Forbidden
133 details: This request is forbidden
135 $ref: '#/components/schemas/ErrorMessage'
136 description: Forbidden
142 message: Conflicting request
143 details: The request cannot be processed as the resource is in use.
145 $ref: '#/components/schemas/ErrorMessage'
146 description: Conflict
152 message: Internal Server Error
153 details: Internal Server Error occurred
155 $ref: '#/components/schemas/ErrorMessage'
156 description: Internal Server Error
157 summary: Delete a dataspace
162 description: Create a new dataspace
163 operationId: createDataspaceV2
165 - description: dataspace-name
170 example: my-dataspace
174 description: Created without response body
181 details: The provided request is not valid
183 $ref: '#/components/schemas/ErrorMessage'
184 description: Bad Request
190 message: Request Forbidden
191 details: This request is forbidden
193 $ref: '#/components/schemas/ErrorMessage'
194 description: Forbidden
200 message: Conflicting request
201 details: The request cannot be processed as the resource is in use.
203 $ref: '#/components/schemas/ErrorMessage'
204 description: Conflict
210 message: Internal Server Error
211 details: Internal Server Error occurred
213 $ref: '#/components/schemas/ErrorMessage'
214 description: Internal Server Error
215 summary: Create a dataspace
218 /{apiVersion}/admin/dataspaces:
220 description: Read all dataspaces
221 operationId: getAllDataspaces
223 - description: apiVersion
239 $ref: '#/components/schemas/DataspaceDetails'
248 details: The provided request is not valid
250 $ref: '#/components/schemas/ErrorMessage'
251 description: Bad Request
257 message: Request Forbidden
258 details: This request is forbidden
260 $ref: '#/components/schemas/ErrorMessage'
261 description: Forbidden
267 message: Internal Server Error
268 details: Internal Server Error occurred
270 $ref: '#/components/schemas/ErrorMessage'
271 description: Internal Server Error
272 summary: Get all dataspaces
275 /{apiVersion}/admin/dataspaces/{dataspace-name}:
277 description: Read a dataspace given a dataspace name
278 operationId: getDataspace
280 - description: apiVersion
290 - description: dataspace-name
295 example: my-dataspace
302 $ref: '#/components/schemas/DataspaceDetails'
310 details: The provided request is not valid
312 $ref: '#/components/schemas/ErrorMessage'
313 description: Bad Request
319 message: Request Forbidden
320 details: This request is forbidden
322 $ref: '#/components/schemas/ErrorMessage'
323 description: Forbidden
329 message: Internal Server Error
330 details: Internal Server Error occurred
332 $ref: '#/components/schemas/ErrorMessage'
333 description: Internal Server Error
334 summary: Get a dataspace
337 /v1/dataspaces/{dataspace-name}/anchors:
340 description: Create a new anchor in the given dataspace
341 operationId: createAnchor
343 - description: dataspace-name
348 example: my-dataspace
350 - description: schema-set-name
352 name: schema-set-name
355 example: my-schema-set
357 - description: anchor-name
378 details: The provided request is not valid
380 $ref: '#/components/schemas/ErrorMessage'
381 description: Bad Request
387 message: Request Forbidden
388 details: This request is forbidden
390 $ref: '#/components/schemas/ErrorMessage'
391 description: Forbidden
397 message: Conflicting request
398 details: The request cannot be processed as the resource is in use.
400 $ref: '#/components/schemas/ErrorMessage'
401 description: Conflict
407 message: Internal Server Error
408 details: Internal Server Error occurred
410 $ref: '#/components/schemas/ErrorMessage'
411 description: Internal Server Error
412 summary: Create an anchor
415 /v2/dataspaces/{dataspace-name}/anchors:
417 description: Create a new anchor in the given dataspace
418 operationId: createAnchorV2
420 - description: dataspace-name
425 example: my-dataspace
427 - description: schema-set-name
429 name: schema-set-name
432 example: my-schema-set
434 - description: anchor-name
443 description: Created without response body
450 details: The provided request is not valid
452 $ref: '#/components/schemas/ErrorMessage'
453 description: Bad Request
459 message: Request Forbidden
460 details: This request is forbidden
462 $ref: '#/components/schemas/ErrorMessage'
463 description: Forbidden
469 message: Conflicting request
470 details: The request cannot be processed as the resource is in use.
472 $ref: '#/components/schemas/ErrorMessage'
473 description: Conflict
479 message: Internal Server Error
480 details: Internal Server Error occurred
482 $ref: '#/components/schemas/ErrorMessage'
483 description: Internal Server Error
484 summary: Create an anchor
487 /{apiVersion}/dataspaces/{dataspace-name}/anchors:
489 description: "Read all anchors, given a dataspace"
490 operationId: getAnchors
492 - description: apiVersion
502 - description: dataspace-name
507 example: my-dataspace
515 $ref: '#/components/schemas/AnchorDetails'
524 details: The provided request is not valid
526 $ref: '#/components/schemas/ErrorMessage'
527 description: Bad Request
533 message: Request Forbidden
534 details: This request is forbidden
536 $ref: '#/components/schemas/ErrorMessage'
537 description: Forbidden
543 message: Internal Server Error
544 details: Internal Server Error occurred
546 $ref: '#/components/schemas/ErrorMessage'
547 description: Internal Server Error
551 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
553 description: Delete an anchor given an anchor name and a dataspace
554 operationId: deleteAnchor
556 - description: apiVersion
566 - description: dataspace-name
571 example: my-dataspace
573 - description: anchor-name
583 description: No Content
590 details: The provided request is not valid
592 $ref: '#/components/schemas/ErrorMessage'
593 description: Bad Request
599 message: Request Forbidden
600 details: This request is forbidden
602 $ref: '#/components/schemas/ErrorMessage'
603 description: Forbidden
609 message: Internal Server Error
610 details: Internal Server Error occurred
612 $ref: '#/components/schemas/ErrorMessage'
613 description: Internal Server Error
614 summary: Delete an anchor
618 description: Read an anchor given an anchor name and a dataspace
619 operationId: getAnchor
621 - description: apiVersion
631 - description: dataspace-name
636 example: my-dataspace
638 - description: anchor-name
650 $ref: '#/components/schemas/AnchorDetails'
658 details: The provided request is not valid
660 $ref: '#/components/schemas/ErrorMessage'
661 description: Bad Request
667 message: Request Forbidden
668 details: This request is forbidden
670 $ref: '#/components/schemas/ErrorMessage'
671 description: Forbidden
677 message: Internal Server Error
678 details: Internal Server Error occurred
680 $ref: '#/components/schemas/ErrorMessage'
681 description: Internal Server Error
682 summary: Get an anchor
685 /v1/dataspaces/{dataspace-name}/schema-sets:
688 description: Create a new schema set in the given dataspace
689 operationId: createSchemaSet
691 - description: dataspace-name
696 example: my-dataspace
698 - description: schema-set-name
700 name: schema-set-name
703 example: my-schema-set
709 $ref: '#/components/schemas/MultipartFile'
725 details: The provided request is not valid
727 $ref: '#/components/schemas/ErrorMessage'
728 description: Bad Request
734 message: Request Forbidden
735 details: This request is forbidden
737 $ref: '#/components/schemas/ErrorMessage'
738 description: Forbidden
744 message: Conflicting request
745 details: The request cannot be processed as the resource is in use.
747 $ref: '#/components/schemas/ErrorMessage'
748 description: Conflict
754 message: Internal Server Error
755 details: Internal Server Error occurred
757 $ref: '#/components/schemas/ErrorMessage'
758 description: Internal Server Error
759 summary: Create a schema set
762 /v2/dataspaces/{dataspace-name}/schema-sets:
764 description: Create a new schema set in the given dataspace
765 operationId: createSchemaSetV2
767 - description: dataspace-name
772 example: my-dataspace
774 - description: schema-set-name
776 name: schema-set-name
779 example: my-schema-set
785 $ref: '#/components/schemas/MultipartFile'
789 description: Created without response body
796 details: The provided request is not valid
798 $ref: '#/components/schemas/ErrorMessage'
799 description: Bad Request
805 message: Request Forbidden
806 details: This request is forbidden
808 $ref: '#/components/schemas/ErrorMessage'
809 description: Forbidden
815 message: Conflicting request
816 details: The request cannot be processed as the resource is in use.
818 $ref: '#/components/schemas/ErrorMessage'
819 description: Conflict
825 message: Internal Server Error
826 details: Internal Server Error occurred
828 $ref: '#/components/schemas/ErrorMessage'
829 description: Internal Server Error
830 summary: Create a schema set
833 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
835 description: "Read all schema sets, given a dataspace"
836 operationId: getSchemaSets
838 - description: apiVersion
848 - description: dataspace-name
853 example: my-dataspace
861 $ref: '#/components/schemas/SchemaSetDetails'
870 details: The provided request is not valid
872 $ref: '#/components/schemas/ErrorMessage'
873 description: Bad Request
879 message: Request Forbidden
880 details: This request is forbidden
882 $ref: '#/components/schemas/ErrorMessage'
883 description: Forbidden
889 message: Internal Server Error
890 details: Internal Server Error occurred
892 $ref: '#/components/schemas/ErrorMessage'
893 description: Internal Server Error
894 summary: Get schema sets
897 /{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
899 description: Delete a schema set given a schema set name and a dataspace
900 operationId: deleteSchemaSet
902 - description: apiVersion
912 - description: dataspace-name
917 example: my-dataspace
919 - description: schema-set-name
921 name: schema-set-name
924 example: my-schema-set
929 description: No Content
936 details: The provided request is not valid
938 $ref: '#/components/schemas/ErrorMessage'
939 description: Bad Request
945 message: Request Forbidden
946 details: This request is forbidden
948 $ref: '#/components/schemas/ErrorMessage'
949 description: Forbidden
955 message: Conflicting request
956 details: The request cannot be processed as the resource is in use.
958 $ref: '#/components/schemas/ErrorMessage'
959 description: Conflict
965 message: Internal Server Error
966 details: Internal Server Error occurred
968 $ref: '#/components/schemas/ErrorMessage'
969 description: Internal Server Error
970 summary: Delete a schema set
974 description: Read a schema set given a schema set name and a dataspace
975 operationId: getSchemaSet
977 - description: apiVersion
987 - description: dataspace-name
992 example: my-dataspace
994 - description: schema-set-name
996 name: schema-set-name
999 example: my-schema-set
1006 $ref: '#/components/schemas/SchemaSetDetails'
1013 message: Bad Request
1014 details: The provided request is not valid
1016 $ref: '#/components/schemas/ErrorMessage'
1017 description: Bad Request
1023 message: Request Forbidden
1024 details: This request is forbidden
1026 $ref: '#/components/schemas/ErrorMessage'
1027 description: Forbidden
1033 message: Internal Server Error
1034 details: Internal Server Error occurred
1036 $ref: '#/components/schemas/ErrorMessage'
1037 description: Internal Server Error
1038 summary: Get a schema set
1041 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1044 description: Get a node with an option to retrieve all the children for a given
1045 anchor and dataspace
1046 operationId: getNodeByDataspaceAndAnchor
1048 - description: dataspace-name
1050 name: dataspace-name
1053 example: my-dataspace
1055 - description: anchor-name
1062 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1065 value: /shops/bookstore
1066 list attributes xpath:
1067 value: "/shops/bookstore/categories[@code=1]"
1074 - description: include-descendants
1076 name: include-descendants
1088 $ref: '#/components/examples/dataSample'
1098 message: Bad Request
1099 details: The provided request is not valid
1101 $ref: '#/components/schemas/ErrorMessage'
1102 description: Bad Request
1108 message: Request Forbidden
1109 details: This request is forbidden
1111 $ref: '#/components/schemas/ErrorMessage'
1112 description: Forbidden
1118 message: Internal Server Error
1119 details: Internal Server Error occurred
1121 $ref: '#/components/schemas/ErrorMessage'
1122 description: Internal Server Error
1126 x-codegen-request-body-name: xpath
1127 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
1129 description: Get a node with an option to retrieve all the children for a given
1130 anchor and dataspace
1131 operationId: getNodeByDataspaceAndAnchorV2
1133 - description: dataspace-name
1135 name: dataspace-name
1138 example: my-dataspace
1140 - description: anchor-name
1147 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1150 value: /shops/bookstore
1151 list attributes xpath:
1152 value: "/shops/bookstore/categories[@code=1]"
1159 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
1160 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
1175 $ref: '#/components/examples/dataSample'
1185 message: Bad Request
1186 details: The provided request is not valid
1188 $ref: '#/components/schemas/ErrorMessage'
1189 description: Bad Request
1195 message: Request Forbidden
1196 details: This request is forbidden
1198 $ref: '#/components/schemas/ErrorMessage'
1199 description: Forbidden
1205 message: Internal Server Error
1206 details: Internal Server Error occurred
1208 $ref: '#/components/schemas/ErrorMessage'
1209 description: Internal Server Error
1213 x-codegen-request-body-name: xpath
1214 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
1216 description: Delete a datanode for a given dataspace and anchor given a node
1218 operationId: deleteDataNode
1220 - description: apiVersion
1230 - description: dataspace-name
1232 name: dataspace-name
1235 example: my-dataspace
1237 - description: anchor-name
1244 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1247 value: /shops/bookstore
1248 list attributes xpath:
1249 value: "/shops/bookstore/categories[@code=1]"
1256 - description: observed-timestamp
1258 name: observed-timestamp
1261 example: 2021-03-21T00:10:34.030-0100
1266 description: No Content
1272 message: Bad Request
1273 details: The provided request is not valid
1275 $ref: '#/components/schemas/ErrorMessage'
1276 description: Bad Request
1282 message: Request Forbidden
1283 details: This request is forbidden
1285 $ref: '#/components/schemas/ErrorMessage'
1286 description: Forbidden
1292 message: Internal Server Error
1293 details: Internal Server Error occurred
1295 $ref: '#/components/schemas/ErrorMessage'
1296 description: Internal Server Error
1297 summary: Delete a data node
1301 description: Update a data node leaves for a given dataspace and anchor and
1302 a parent node xpath. This operation is currently supported for one top level
1304 operationId: updateNodeLeaves
1306 - description: apiVersion
1316 - description: dataspace-name
1318 name: dataspace-name
1321 example: my-dataspace
1323 - description: anchor-name
1330 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1333 value: /shops/bookstore
1334 list attributes xpath:
1335 value: "/shops/bookstore/categories[@code=1]"
1342 - description: observed-timestamp
1344 name: observed-timestamp
1347 example: 2021-03-21T00:10:34.030-0100
1354 $ref: '#/components/examples/dataSample'
1374 message: Bad Request
1375 details: The provided request is not valid
1377 $ref: '#/components/schemas/ErrorMessage'
1378 description: Bad Request
1384 message: Request Forbidden
1385 details: This request is forbidden
1387 $ref: '#/components/schemas/ErrorMessage'
1388 description: Forbidden
1394 message: Internal Server Error
1395 details: Internal Server Error occurred
1397 $ref: '#/components/schemas/ErrorMessage'
1398 description: Internal Server Error
1399 summary: Update node leaves
1403 description: Create a node for a given anchor and dataspace
1404 operationId: createNode
1406 - description: apiVersion
1416 - description: dataspace-name
1418 name: dataspace-name
1421 example: my-dataspace
1423 - description: anchor-name
1430 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1433 value: /shops/bookstore
1434 list attributes xpath:
1435 value: "/shops/bookstore/categories[@code=1]"
1442 - description: observed-timestamp
1444 name: observed-timestamp
1447 example: 2021-03-21T00:10:34.030-0100
1449 - description: Content type header
1454 example: application/json
1461 $ref: '#/components/examples/dataSample'
1468 $ref: '#/components/examples/dataSampleXml'
1480 example: my-resource
1482 description: Created
1488 message: Bad Request
1489 details: The provided request is not valid
1491 $ref: '#/components/schemas/ErrorMessage'
1492 description: Bad Request
1498 message: Request Forbidden
1499 details: This request is forbidden
1501 $ref: '#/components/schemas/ErrorMessage'
1502 description: Forbidden
1508 message: Conflicting request
1509 details: The request cannot be processed as the resource is in use.
1511 $ref: '#/components/schemas/ErrorMessage'
1512 description: Conflict
1518 message: Internal Server Error
1519 details: Internal Server Error occurred
1521 $ref: '#/components/schemas/ErrorMessage'
1522 description: Internal Server Error
1523 summary: Create a node
1527 description: "Replace a node with descendants for a given dataspace, anchor\
1528 \ and a parent node xpath"
1529 operationId: replaceNode
1531 - description: apiVersion
1541 - description: dataspace-name
1543 name: dataspace-name
1546 example: my-dataspace
1548 - description: anchor-name
1555 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1558 value: /shops/bookstore
1559 list attributes xpath:
1560 value: "/shops/bookstore/categories[@code=1]"
1567 - description: observed-timestamp
1569 name: observed-timestamp
1572 example: 2021-03-21T00:10:34.030-0100
1579 $ref: '#/components/examples/dataSample'
1599 message: Bad Request
1600 details: The provided request is not valid
1602 $ref: '#/components/schemas/ErrorMessage'
1603 description: Bad Request
1609 message: Request Forbidden
1610 details: This request is forbidden
1612 $ref: '#/components/schemas/ErrorMessage'
1613 description: Forbidden
1619 message: Internal Server Error
1620 details: Internal Server Error occurred
1622 $ref: '#/components/schemas/ErrorMessage'
1623 description: Internal Server Error
1624 summary: Replace a node with descendants
1627 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1630 description: Delete one or all list element(s) for a given anchor and dataspace
1631 operationId: deleteListOrListElement
1633 - description: dataspace-name
1635 name: dataspace-name
1638 example: my-dataspace
1640 - description: anchor-name
1647 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1650 value: /shops/bookstore
1651 list attributes xpath:
1652 value: "/shops/bookstore/categories[@code=1]"
1658 - description: observed-timestamp
1660 name: observed-timestamp
1663 example: 2021-03-21T00:10:34.030-0100
1668 description: No Content
1674 message: Bad Request
1675 details: The provided request is not valid
1677 $ref: '#/components/schemas/ErrorMessage'
1678 description: Bad Request
1684 message: Request Forbidden
1685 details: This request is forbidden
1687 $ref: '#/components/schemas/ErrorMessage'
1688 description: Forbidden
1694 message: Internal Server Error
1695 details: Internal Server Error occurred
1697 $ref: '#/components/schemas/ErrorMessage'
1698 description: Internal Server Error
1699 summary: Delete one or all list element(s)
1702 /{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
1704 description: Add list element(s) to a list for a given anchor and dataspace
1705 operationId: addListElements
1707 - description: apiVersion
1717 - description: dataspace-name
1719 name: dataspace-name
1722 example: my-dataspace
1724 - description: anchor-name
1731 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1734 value: /shops/bookstore
1735 list attributes xpath:
1736 value: "/shops/bookstore/categories[@code=1]"
1742 - description: observed-timestamp
1744 name: observed-timestamp
1747 example: 2021-03-21T00:10:34.030-0100
1754 $ref: '#/components/examples/dataSample'
1764 example: my-resource
1766 description: Created
1772 message: Bad Request
1773 details: The provided request is not valid
1775 $ref: '#/components/schemas/ErrorMessage'
1776 description: Bad Request
1782 message: Request Forbidden
1783 details: This request is forbidden
1785 $ref: '#/components/schemas/ErrorMessage'
1786 description: Forbidden
1792 message: Internal Server Error
1793 details: Internal Server Error occurred
1795 $ref: '#/components/schemas/ErrorMessage'
1796 description: Internal Server Error
1797 summary: Add list element(s)
1801 description: "Replace list content under a given parent, anchor and dataspace"
1802 operationId: replaceListContent
1804 - description: apiVersion
1814 - description: dataspace-name
1816 name: dataspace-name
1819 example: my-dataspace
1821 - description: anchor-name
1828 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1831 value: /shops/bookstore
1832 list attributes xpath:
1833 value: "/shops/bookstore/categories[@code=1]"
1839 - description: observed-timestamp
1841 name: observed-timestamp
1844 example: 2021-03-21T00:10:34.030-0100
1851 $ref: '#/components/examples/dataSample'
1871 message: Bad Request
1872 details: The provided request is not valid
1874 $ref: '#/components/schemas/ErrorMessage'
1875 description: Bad Request
1881 message: Request Forbidden
1882 details: This request is forbidden
1884 $ref: '#/components/schemas/ErrorMessage'
1885 description: Forbidden
1891 message: Internal Server Error
1892 details: Internal Server Error occurred
1894 $ref: '#/components/schemas/ErrorMessage'
1895 description: Internal Server Error
1896 summary: Replace list content
1899 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/delta:
1901 description: Get delta between two anchors within a given dataspace
1902 operationId: getDeltaByDataspaceAndAnchors
1904 - description: dataspace-name
1906 name: dataspace-name
1909 example: my-dataspace
1911 - description: anchor-name
1918 - description: target-anchor-name
1920 name: target-anchor-name
1925 - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
1928 value: /shops/bookstore
1929 list attributes xpath:
1930 value: "/shops/bookstore/categories[@code=1]"
1937 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
1938 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
1953 $ref: '#/components/examples/deltaReportSample'
1963 message: Bad Request
1964 details: The provided request is not valid
1966 $ref: '#/components/schemas/ErrorMessage'
1967 description: Bad Request
1973 message: Request Forbidden
1974 details: This request is forbidden
1976 $ref: '#/components/schemas/ErrorMessage'
1977 description: Forbidden
1983 message: Internal Server Error
1984 details: Internal Server Error occurred
1986 $ref: '#/components/schemas/ErrorMessage'
1987 description: Internal Server Error
1988 summary: Get delta between anchors in the same dataspace
1991 x-codegen-request-body-name: xpath
1992 /v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
1995 description: Query data nodes for the given dataspace and anchor using CPS path
1996 operationId: getNodesByDataspaceAndAnchorAndCpsPath
1998 - description: dataspace-name
2000 name: dataspace-name
2003 example: my-dataspace
2005 - description: anchor-name
2012 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2016 list attributes cps path:
2017 value: "//categories[@code=1]"
2024 - description: include-descendants
2026 name: include-descendants
2038 $ref: '#/components/examples/dataSample'
2048 message: Bad Request
2049 details: The provided request is not valid
2051 $ref: '#/components/schemas/ErrorMessage'
2052 description: Bad Request
2058 message: Request Forbidden
2059 details: This request is forbidden
2061 $ref: '#/components/schemas/ErrorMessage'
2062 description: Forbidden
2068 message: Internal Server Error
2069 details: Internal Server Error occurred
2071 $ref: '#/components/schemas/ErrorMessage'
2072 description: Internal Server Error
2073 summary: Query data nodes
2076 x-codegen-request-body-name: xpath
2077 /v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
2079 description: Query data nodes for the given dataspace and anchor using CPS path
2080 operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
2082 - description: dataspace-name
2084 name: dataspace-name
2087 example: my-dataspace
2089 - description: anchor-name
2096 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2100 list attributes cps path:
2101 value: "//categories[@code=1]"
2108 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2109 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2124 $ref: '#/components/examples/dataSample'
2134 message: Bad Request
2135 details: The provided request is not valid
2137 $ref: '#/components/schemas/ErrorMessage'
2138 description: Bad Request
2144 message: Request Forbidden
2145 details: This request is forbidden
2147 $ref: '#/components/schemas/ErrorMessage'
2148 description: Forbidden
2154 message: Internal Server Error
2155 details: Internal Server Error occurred
2157 $ref: '#/components/schemas/ErrorMessage'
2158 description: Internal Server Error
2159 summary: Query data nodes
2162 x-codegen-request-body-name: xpath
2163 /v2/dataspaces/{dataspace-name}/nodes/query:
2165 description: Query data nodes for the given dataspace across anchors using CPS
2167 operationId: getNodesByDataspaceAndCpsPath
2169 - description: dataspace-name
2171 name: dataspace-name
2174 example: my-dataspace
2176 - description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2180 list attributes cps path:
2181 value: "//categories[@code=1]"
2188 - description: "Number of descendants to query. Allowed values are 'none', 'all',\
2189 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive\
2198 - description: page index for pagination over anchors. It must be greater then
2206 - description: number of records (anchors) per page. It must be greater then
2220 $ref: '#/components/examples/dataSampleAcrossAnchors'
2230 message: Bad Request
2231 details: The provided request is not valid
2233 $ref: '#/components/schemas/ErrorMessage'
2234 description: Bad Request
2240 message: Request Forbidden
2241 details: This request is forbidden
2243 $ref: '#/components/schemas/ErrorMessage'
2244 description: Forbidden
2250 message: Internal Server Error
2251 details: Internal Server Error occurred
2253 $ref: '#/components/schemas/ErrorMessage'
2254 description: Internal Server Error
2255 summary: Query data nodes across anchors
2258 x-codegen-request-body-name: xpath
2264 bookstore-name: Chapters
2271 value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
2272 <bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
2273 </categories> </bookstore> </stores>
2277 xpath: "/bookstore/categories/[@code=3]"
2282 xpath: "/bookstore/categories/[@code=1]"
2287 xpath: "/bookstore/categories/[@code=2]"
2292 dataSampleAcrossAnchors:
2294 - anchorName: bookstore1
2297 bookstore-name: Chapters
2303 - anchorName: bookstore2
2306 bookstore-name: Chapters
2313 dataspaceNameInQuery:
2314 description: dataspace-name
2316 name: dataspace-name
2319 example: my-dataspace
2322 description: apiVersion
2332 dataspaceNameInPath:
2333 description: dataspace-name
2335 name: dataspace-name
2338 example: my-dataspace
2340 schemaSetNameInQuery:
2341 description: schema-set-name
2343 name: schema-set-name
2346 example: my-schema-set
2349 description: anchor-name
2357 description: anchor-name
2364 schemaSetNameInPath:
2365 description: schema-set-name
2367 name: schema-set-name
2370 example: my-schema-set
2373 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2376 value: /shops/bookstore
2377 list attributes xpath:
2378 value: "/shops/bookstore/categories[@code=1]"
2385 includeDescendantsOptionInQuery:
2386 description: include-descendants
2388 name: include-descendants
2395 description: "Number of descendants to query. Allowed values are 'none', 'all',\
2396 \ 'direct', 1 (for direct), -1 (for all), 0 (for none) and any positive number."
2404 observedTimestampInQuery:
2405 description: observed-timestamp
2407 name: observed-timestamp
2410 example: 2021-03-21T00:10:34.030-0100
2413 description: Content type header
2418 example: application/json
2420 requiredXpathInQuery:
2421 description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
2424 value: /shops/bookstore
2425 list attributes xpath:
2426 value: "/shops/bookstore/categories[@code=1]"
2432 targetAnchorNameInQuery:
2433 description: target-anchor-name
2435 name: target-anchor-name
2441 description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
2445 list attributes cps path:
2446 value: "//categories[@code=1]"
2454 description: page index for pagination over anchors. It must be greater then
2463 description: number of records (anchors) per page. It must be greater then zero
2476 example: my-resource
2478 description: Created
2484 message: Bad Request
2485 details: The provided request is not valid
2487 $ref: '#/components/schemas/ErrorMessage'
2488 description: Bad Request
2494 message: Request Forbidden
2495 details: This request is forbidden
2497 $ref: '#/components/schemas/ErrorMessage'
2498 description: Forbidden
2504 message: Conflicting request
2505 details: The request cannot be processed as the resource is in use.
2507 $ref: '#/components/schemas/ErrorMessage'
2508 description: Conflict
2509 InternalServerError:
2514 message: Internal Server Error
2515 details: Internal Server Error occurred
2517 $ref: '#/components/schemas/ErrorMessage'
2518 description: Internal Server Error
2521 description: No Content
2523 description: Created without response body
2549 example: my-dataspace
2551 title: Dataspace details by dataspace Name
2555 schemaSetName: my-schema-set
2556 dataspaceName: my-dataspace
2563 example: my-dataspace
2566 example: my-schema-set
2568 title: Anchor details by anchor Name
2573 description: multipartFile
2581 dataspaceName: my-dataspace
2584 - name: my-module-reference-name
2585 namespace: my-module-reference-namespace
2586 revision: my-module-reference-revision
2587 - name: my-module-reference-name
2588 namespace: my-module-reference-namespace
2589 revision: my-module-reference-revision
2592 example: my-dataspace
2596 $ref: '#/components/schemas/ModuleReferences'
2599 example: my-schema-set
2603 title: Schema set details by dataspace and schemasetName
2607 name: my-module-reference-name
2608 namespace: my-module-reference-namespace
2609 revision: my-module-reference-revision
2612 example: my-module-reference-name
2615 example: my-module-reference-namespace
2618 example: my-module-reference-revision
2620 title: Module reference object