aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api
AgeCommit message (Collapse)AuthorFilesLines
2024-07-10Policy Executor API, make Authorization header optionalToineSiebelink1-1/+1
Issue-ID: CPS-22291 Change-Id: I2b8f9b97c92dfc640c8b40b7053c609bbdcb2f6e Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-07-08Create PolicyExecutor StubToineSiebelink1-12/+20
- Generate interface from OpenApi in RTD docs - Fixed Content Type in OpenAPI - Fixed Paths in OpenAPI - Made Authorization header compulsory in OpenAPI - All 'enum' values in OpenAPI lowercase (in linr with CPS/NCMP conventions) - Added impl with some basic functionality - Added testware - Pom includes docker image creation - Docker compose updated to deploy stub Issue-ID: CPS-2301 Change-Id: I462ad5c70474b2813fc04005c0d20a1b15b574ec Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2024-07-03Add Policy Executor Open API Interface definitionToineSiebelink1-0/+214
- OPenApi in RTD only (for now) - Bear authentication included in OpenApi - Placeholder RTD page (to be completed upon feature delivery) - For consistency (and color coding in editors) I put all Description and Example strings inside double qoutes "..." Issue-ID: CPS-2291 Change-Id: I7f16cdce2a06cb011997005fa8b86b54c044304a Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-06-20Release notes and OpenApi syncmpriyank1-2/+136
- Release notes updated and openapi syncd for CPS-Core and NCMP Issue-ID: CPS-2283 Change-Id: Iafdebc65cbcec01bf0d6e6963bd9601fea5f5081 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-05-22Remove allowReserved from Swagger definitions for CPS & NCMPToineSiebelink1-24/+10
- this option was used on some URL parameters (by accident) - does not seem to affect production code but is at least misleading Issue-ID: CPS-2230 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: I32712a840346715f4891304c2059d49f10e959d6
2024-05-01Update OpenAPI docs for 3.4.8danielhanrahan2-18/+42
Issue-ID: CPS-2205 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ib520a55b099b7a89751dab7032cabeba19b6a934
2024-03-13Modify the get cmHandle api to return dataProducerIdentifier, moduleSetTag, ↵JvD_Ericsson2-0/+20
and alternateId (CPS-1964 2) Issue-ID: CPS-2113 Signed-off-by: JvD_Ericsson <jeff.van.dam@est.tech> Change-Id: I672e5c8408e77a5fa15d6fc2f41438aca705484c
2024-02-29Release notes added for 3.4.6mpriyank3-490/+43
- added the release notes and openapi documentation Issue-ID: CPS-2135 Change-Id: Ib224353ca5a529b6788ecb67c6432b806acdf557 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-02-07Update release notes for CPS 3.4.3danielhanrahan1-5/+36
- updated release notes for 3.4.3 - updated openapi files Issue-ID: CPS-2077 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I2ded94a243dbe93885525d73f90dde3dbbb79696
2023-12-20Release notes and OpenAPI docs updated for 3.4.1danielhanrahan3-0/+147
- Update release notes - Update OpenAPI docs - Made RST files not executable Issue-ID: CPS-2017 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I85bd7cb68d960c9522b80048007cfe913cd49ed4
2023-11-06Step 1 and 2 of release processmpriyank1-0/+11
- Sync the openapi docs and the release notes - Also commenting a test scenario coz of unrelated failure. will be fixed later Issue-ID: CPS-1949 Change-Id: I27c955e569acdfe1f699f345fa583f7bce95e76a Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-10-17[BUG] Fix for Swagger UI generationegernug2-3/+34
Issue-ID: CPS-1913 Signed-off-by: egernug <gerard.nugent@est.tech> Change-Id: Ib8a1b5fddc9957bd371fbb4dc54d018b25af3679
2023-09-20openapi yml update for 3.3.7 releasedanielhanrahan1-0/+8
Issue-ID: CPS-1882 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I2d34631e5a3f8832adb577c0b19384b62b4dd24d
2023-08-22Release notes and openapi yml updatempriyank3-1395/+1413
- add to rst file and update the rest api changes Issue-ID: CPS-1846 Change-Id: I242fc98c025ffe0bf654640ad16dfef2bb0fcbaf Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-08-03Merge "Support pagination in query across all anchors(ep4)"Luke Gleeson1-1/+20
2023-08-02Support pagination in query across all anchors(ep4)rajesh.kumar1-1/+20
Add pagination query parameters in query across all anchors API pagination parameters (pageIndex and pageSize) are optional default is to query all fragments each pageSize represents number of records(number of anchors) TotalRecords is returned in response header to find number of pages. - If pagination option is provided in request then query number of anchors equal to pageSize. pageIndex is used for setting offset. - return number of records(one anchor per record) as per pagesize and pageSize Issue-ID: CPS-1605 Change-ID: I73f97f986a817d423f93a8d922dcd9647b2504bc Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-07-28Add 'direct' keyword to descendants option to query direct children (ep1)Rudrangi Anupriya1-8/+8
-added 'direct' keyword also to Fetch Descendants Option along with 'all' and 'none' to Query direct child. -added unit tests to test direct keyword Issue-ID:CPS-1784 Change-Id: Iab7f59fbeebb03703626132c6d5c2afde0e5ab4d Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2023-06-29Openapi file and RTD updatempriyank3-2796/+3071
- Step-1 and 2 of the release process Issue-ID: CPS-1771 Change-Id: I2c5f2f04fdf6344c788aa47a82090b2b37d1505f Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-06-15Update release docsdanielhanrahan1-54/+39
- Also synched up the API changes in openapi yml file - Step 1 and 2 of the release process Issue-ID: CPS-1703 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Id47822737df3b89dffddb90413a53cac2b7ced6a
2023-05-02Update release docsmpriyank3-492/+1092
- Also synched up the API changes in openapi yml file - Step 1 and 2 of the release process Issue-ID: CPS-1662 Change-Id: I5b9485497a27a3dee8639faedfa9c1bd8ed3265e Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-04-20Correct documentation for GET node APIemaclee1-9/+9
- Add new section on documentation to describe XPath - Correct doc description on GET node API Issue-ID: CPS-1607 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I23e4ccd1185a2d93fbb0b9e02e9daab949c0f952
2023-03-22Update documnetationmpriyank1-759/+781
- update release notes and sync the openapi specs as per the latest changes Issue-ID: CPS-1572 Change-Id: I1dedad736664e3bdd164ba371270c1cf4586515d Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-03-21Query data nodes across all anchors under one dataspacerajesh.kumar1-0/+87
Issue-ID: CPS-1396 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1412ab Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-03-20CPS-1526 Fix response message for PATCH operationarpitsingh1-2/+2
- Fixed the Response code and message when trying to update multiple data trees at once - Response code changed to 400 - Since the patch operation across multiple data trees is not supported when xpath is set to root node xpath, appropriate message is returned in response - Existing functionality of updating one data node with root node xpath remains as it is. - Updated API documentation and release notes Issue-ID: CPS-1526 Signed-off-by: arpitsingh <as00745003@techmahindra.com> Change-Id: I5d25a06bb5d407316ccfb2f85877cbe56a9f6f31
2023-02-08Release Steps 1 and 2mpriyank1-4/+5
- added the jira ticket as part of step1 - copied the changes of openapi.yaml as part of step2 of release process Issue-ID: CPS-1476 Change-Id: I877757e0396e6349b1ab5e966ae4440c4fead829 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2023-02-03Descendants description changed in openApirajesh.kumar1-3/+2
Issue-ID: CPS-1381 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0203aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2023-01-30Edit example given for ncmp datastoreseanbeirne1-6/+6
Issue-ID: CPS-1468 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Id746604fca83333f4ee186ce96ea80cb779c4ac2
2023-01-26Update openAPI documentation for release processseanbeirne3-1150/+1515
Issue-ID: CPS-1385 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Ia0b011d4497e7d95f9b625514e8b3216575df044
2023-01-23Added depth parameter in query nodes API.rajesh.kumar1-2/+192
Issue-ID: CPS-1381 Change-ID: I73f97f986a817d423f93a8d922dcd9647b1206bb Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-12-16API versioning supported and added different versions for POST APIsrajesh.kumar1-16/+281
Issue-ID: CPS-1189 Change-ID: I73f97f986a817d423f92f8d922dcd9647b1214aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-12-09Added API to get all schema sets for a given dataspace.rajesh.kumar1-0/+63
Issue-ID: CPS-1187 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0914aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-11-21Merge "Added get APIs for dataspace."Sourabh Sourabh1-1/+126
2022-11-18Added get APIs for dataspace.rajesh.kumar1-1/+126
Issue-ID: CPS-1186 Change-ID: I73f97f986a817d423f93a8d922dcd9647b0829aa Signed-off-by: rajesh.kumar <rk00747546@techmahindra.com>
2022-11-15Query data NCMP-Operational with CPSpathlukegleeson1-6/+6
New GET Endpoint: /v1/ch/{cm-handle}/data/ds/{ncmp-datastore-name}/query?cps-path={CPSPath} Implemented error for {ncmp-datastore-name} other than operational - (Toine) Refactored and renamed (abstract) handler for better re-use Mainly by introducing a separate handler for OperationalQuery Reviewers Toine, Sourabh, Priyank Issue-ID: CPS-1002 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iaca018869d95d4ce800072431baa190050a6dad0
2022-10-24[NCMP] Add Basic Auth to OpenAPI DefinitionsJosephKeenan3-0/+21
-Adding basic auth to OpenAPI definitions Issue-ID: CPS-1350 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: Iab677f2abc07eed8c3e2910191b15ba27028ee88
2022-09-07Update doc and release notes after endpoint mergebmiklos3-833/+860
- Update generated swagger files according to changes - Add release notes for the parent ticket Issue-ID: CPS-1001 Issue-ID: CPS-1256 Change-Id: I09aaec26971ae89f4588bfc80d2b80cc4778dfc8 Signed-off-by: bmiklos <miklos.baranyak@est.tech>
2022-09-02Update documentation for NCMP inventory openAPIemaclee3-891/+1381
- added JIRA (CPS-1136) to release notes - updated RTD copies of open api documentation for both cps-rest and cps-ncmp-rest - files were updated by copying the generated sources as outlined on https://wiki.onap.org/display/DW/CPS+Release+Process Issue-ID: CPS-1136 Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech> Change-Id: I929e0e774d8a42ad943eaf8a6ccf4e8891da4b77
2022-08-04Query CM Handles RTDlukegleeson2-46/+123
Updates to RTD for CM Handles Querying Removed documented limitation in CPS path which has since been implemeneted Updated dmi-registry file in RTD modeling Issue-ID: CPS-1161 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I19ff09dadb43a46e14844e198278949f059c6e68
2022-04-05[cps] Fix getResourceDataForPassthroughOperational endpointputhuparambil.aditya1-20/+0
Get endpoint only accepts application/json. Issue-ID: CPS-957 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Ifc7426fbcd6073a39554014dc18b2107b6343b16
2022-04-04Structured Exception details for DMImpriyank1-0/+84
- Introduced DmiErrorMessage in API docs with 502 Bad Gateway - HttpClientRequestException will be thrown which will be exposed as 502 BAD Gateway for the client from NCMP Issue-ID: CPS-917 Change-Id: Iba8f159e8216bc1f63a9ab86208e5c802437e2e8 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-03-15Create primary documentation for Jakarta releaseBruno Sakoto3-381/+1010
* Update release notes * Update openapi documentation * Fix section title hierarchy * Fix admin container directive not found Issue-ID: CPS-935 Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca> Change-Id: Iabdc357aa0168c1becafd6de1ac7703ec3bd1afa
2022-03-01Create Endpoint For Get Cm Handles By NameDylanB95EST2-166/+846
Create endpoint and implement logic for get cm handle details by cm handle name Issue-ID: CPS-817 Change-Id: I83bd2da9219d13fac715a08b19108028ca6f6751 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-02-25Fix success response code CM Handle Registrationmpriyank1-2/+2
- changed registartion response code to 204 NO_CONTENT - improved exception handling for registration API - fixed failing csit related to changed response code - updated the release notes for CPS-892 and CPS-837 Issue-ID: CPS-892 Change-Id: I616e340debf1583b058e7ae6b8960972eec00f3e Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-01-28Support 'public' Cm Handle PropertiesDylanB95EST1-8/+29
Add support for new Public Additional Properties list to Register CM Handles API Issue-ID: CPS-677 Change-Id: I6efc88734da2416f72f71a403622e519398b502d Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2022-01-19[TECHDEBT] Remove deprecated API methods related to NCMPmpriyank1-356/+0
CpsQueryService instantiation removed as it was not in use. License Header updated for Nordix Foundation to 2021-2022. Issue-ID: CPS-642 Change-Id: I1aa204730f5d347d379cfdaaf0740323a317a559 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2021-10-12Updating release notes and openapi.yaml for I release final imageputhuparambil.aditya3-585/+575
Issue-ID: CPS-727 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: I97cd4bca5e395c2fce872d3807bf7b73d1ed97d3
2021-10-11Update open api informationniamhcore1-0/+88
Issue-ID: CPS-626 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I7e8171e215fe55b68580f7f7a8143edc32c62ac9
2021-10-11Update Design & Modeling Sectionslukegleeson1-0/+46
Update both Design and Modeling sections of Cps-Core Documentation Issue-ID: CPS-626 Change-Id: I7b42e0bcedbec8d973557140c503828e33239847 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech>
2021-09-23openapi.yaml should not be modified when the application is compiled revertDylanB95EST2-0/+1693
Revert changes made to bug raised in CPS-674. Files will now need to be added manually as part of the release process. Extra step has been added here https://wiki.onap.org/display/DW/CPS+Release+Process Issue-ID: CPS-674 Change-Id: I3da6ca7aa8154c379d3f1c3b042b4c096275ca62 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-09-22openapi.yaml should not be modified when the application is compiledDylanB95EST2-1646/+0
Make Changes to ignore generated yml files for API Specification for CPS-Core Issue-ID: CPS-674 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Change-Id: I0bff21ccf0353ebf5d0e3e3ffbf0aa9e9c141376 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>