aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api
AgeCommit message (Collapse)AuthorFilesLines
2024-12-12Implementation of Data validation feature in CPS APIsRudrangi Anupriya1-10/+46
Added support to validate JSON/XML data without the need of persisting it in the database. - added "dryRunInQuery" flag as a new query parameter in update/Replace/Add APIs - added new method as part of CpsDataService layer to perform data validation Issue-ID: CPS-2516 Change-Id: I87bb33dd6021567d0fac606d5c4b0168d107311c Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-12-10Policy Executor API Review Board CommentsToineSiebelink1-191/+178
- Implemented Guild review comments in API - Updated Stub to reflect new API and 'support' all operations - Updated production code to use new API - Updated Semi-Integration Tests Issue-ID: CPS-2479 Change-Id: Ibe307b0d859312b534009a384e9f71e1ea2affe0 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-12-03Added performance section and updated api versionmpriyank3-3/+3
- Added a performance section to the release notes - Populated the correct info.version for NCMP and CPS Rest interfaces Issue-ID: CPS-2537 Change-Id: Iae07da57fc45100b4d250fcfb86a95079869b221 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2024-11-28XML content support on Replace list contentRudrangi Anupriya1-0/+19
Here to bring Support for XML Response Entity in Replace List content - Add ContentTypeInheadr in cpsData.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in DataRestController.java - Modify the code return xml Data - written testcase for above changes made Issue-ID: CPS-2411 Change-Id: Ibb7ffb66ccdd03703266123c6d5c2eade0e7cb4a Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-22Make Content-Type header default to JSON for CPS APIsdanielhanrahan1-7/+14
Recent changes for XML support have made Content-Type header mandatory, where before it was not. This change makes CPS default to JSON if Content-Type is not specified. Issue-ID: CPS-2517 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ic3718bfe7aedd6fe9dbd978f520179b184c9c932
2024-11-20Update error response for ncmp endpointsseanbeirne2-9/+9
Issue-ID: CPS-2386 Change-Id: I0d1f09cff202e055be255b365fc2271a5ee43b37 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-20Revert "Update error response for ncmp endpoints"ToineSiebelink2-9/+9
This reverts commit 7e6fee9321e4f13cc4a0d81f83fc3693309cb5d7. Reason for revert: This patch is causing blocking issues at ESH see CPS-2509 Issue-ID: CPS-2509 Change-Id: Ie1bd26ccca4abcac09faf35e2b97491dab32b14d Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-11-18Merge "Update error response for ncmp endpoints"Priyank Maheshwari2-9/+9
2024-11-18Update error response for ncmp endpointsseanbeirne2-9/+9
Issue-ID: CPS-2386 Change-Id: Ib4f37858f5f107e350a13e4bf7ed93493864ce60 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-17XML content support for only cps Query v2Rudrangi Anupriya1-0/+18
Here to bring Support for XML Response Entity in query data nodes - Add ContentTypeInheadr in cpsQueryV2.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in QueryRestController.java - Implement logic to convert data to xml - written testcase for above changes made Issue-ID: CPS-2359 Change-Id: Ieb7eeb66ccbb03703626132c6d5c2eade0e7cb4b Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-13Support alternate Id interface for ncmp inventory /ch/cmhandles endpointseanbeirne2-13/+21
Issue-ID: CPS-2481 Change-Id: I8a200495be1afb9a4f256127f886bed78c77f653 Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-11Merge "Support Alternate-Id for CPS-E05 data batch interface"Priyank Maheshwari2-9/+9
2024-11-05Support Alternate-Id for CPS-E05 data batch interfaceseanbeirne2-9/+9
Issue-ID: CPS-2274 Change-Id: I75163bc7943fca5cbbe8c24601a2dfc184a9e6cc Signed-off-by: seanbeirne <sean.beirne@est.tech>
2024-11-05XML content support on get a nodeRudrangi Anupriya3-15/+80
Here to bring Support for XML Response Entity In GET A NODE - Made changes in components.yml to support contentType as application/xml - Add ContentTypeInheadr in cpsDataV2.yml to support application/xml - Add contentTypeInHeader parameter to accept xml in DataRestController.java - Implemented Logic to convert DataMaps To XML Data - written testcase for above changes made Issue-ID: CPS-2280 Change-Id: Ibe7ffb66ccbb03703626132c6d5c2eade0e7ab4b Signed-off-by: Rudrangi Anupriya <ra00745022@techmahindra.com>
2024-11-01[Module Sync] Log state changes after persistencedanielhanrahan2-3/+40
Currently, module sync will output messages such as: "cm-handle-1 is now in READY state" before the state change is persisted to the DB. If an exception occurs, the new state may not be persisted, which makes debugging hard due to misleading log entries. This commit moves the logging to the LCM state handler immediately after the change is persisted. - Move logging of state changes to LcmEventsCmHandleStateHandler. - Remove unused code in LcmEventsCmHandleStateHandler. - Add tests of state change logging. - Update the main test showing the bug to instead show expected behaviour, but disable test for now using @Ignore. Issue-ID: CPS-2474 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I58646af6df95e07e69ca525744713a7c01c25e41
2024-10-17Release notes and documentation updates for 3.5.4danielhanrahan3-3/+3
- Release notes update - Update openapi info.version to 3.5.4 - Update scheduled-tasks docs to reflect changes in retry mechanism - Update deployment docs to update configurable timer parameters - Remove unused locked-module-sync.sleep-time-ms Issue-ID: CPS-2457 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ieb559bbfe348848c4b8669410861edfeeb6c9bf3
2024-10-15Add missing duplication test in integration test suiteToineSiebelink1-0/+19
- Added test for ModuleSerive.createSchemaSetFromModules() - Unintendedly Updated one swagger file in docs because 1) DT team forgot to update the relevant file 2) Gers committed pom update to automatically update swagger files 3) I ran 'mvn install' Issue-ID: CPS-2399 Change-Id: I33261c32bbca58ff21aff3cde9588617199f104c Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-10-04[CPS] OSLO release changessourabh_sourabh3-163/+246
- Updated open api for cps, ncmp and policy apis. - Updated release notes with bus and features. Issue-ID: CPS-2434 Change-Id: Ib4d80f3939b6e267f228177c817e43832a9384db Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2024-10-04Revert "[1/2] Move Swagger API to docs folder"Lee Anjella Macabuhay1-908/+908
This reverts commit b76392e2d1629d4eb67b10c450cdd954ef678966. Reason for revert: Release blocker Change-Id: Ic477dbaaad34992c8f440981d92f12b977cdf96e Signed-off-by: emaclee <lee.anjella.macabuhay@est.tech>
2024-09-18[1/2] Move Swagger API to docs folderegernug1-908/+908
Code generation moved to docs folder for cps-core Issue-ID: CPS-2332 Change-Id: I9a8c5007a3039e0f46114c589de0756d6de91127 Signed-off-by: egernug <gerard.nugent@est.tech>
2024-09-17Policy Executor API: Add Prefix in YamlToineSiebelink1-3/+1
- Remove servers from yaml. - Add prefix to path in yaml. - Remove basepath prefix from Controller Impl. - Added policy server port to 8093. - Exposed docker env. vars for policy services. Issue-ID: CPS-2291 Change-Id: Idcc9e23f9d63bad2480537dc8d39523fe82b4b83 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Signed-off-by: sourabh_sourabh <sourabh.sourabh@est.tech>
2024-08-21Update openapi for 3.5.2danielhanrahan3-24/+59
- update info.version to 3.5.2 for openapi yamls - update read-the-docs copies of openapi docs Issue-ID: CPS-2374 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I7f726f610fe8eff43e281edfe2fc6d9b08f5fc15
2024-08-01Update OpenAPI Policy ExecutorToineSiebelink1-12/+0
- remove conflict error response in OpenAPI (mistakenly added here but only need for NCMP interface) Issue-ID: CPS-2335 Change-Id: Ib24a4d0853fff2104958879f7d247197725b5870 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
2024-07-31Refactor OpenAPI Policy ExecutorToineSiebelink1-38/+28
- replace payload with request(s) - replace payloadType with schema (one schema for each operation) - include conflict error response in OpenAPI - introduce 4 schemas in NCMP (doc module) for create, update, patch & delete - udpate stub & test to follow new API and use one schema for testign purposes Issue-ID: CPS-2335 Change-Id: Ifc40062ae83429a9ffba350ec3bcc28cb7147293 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech>
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>