aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/swagger/ncmp
AgeCommit message (Collapse)AuthorFilesLines
2024-12-03Added performance section and updated api version for OSLOmpriyank2-2/+2
- Added a performance section to the release notes - Populated correct info.version for NCMP and CPS Rest interfaces Issue-ID: CPS-2537 Change-Id: I5b6a3120bb9b31319f0cd2320f5a98d6e5ebcf25 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
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-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-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-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-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.4danielhanrahan2-2/+2
- 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-04[CPS] OSLO release changessourabh_sourabh1-34/+54
- 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-08-21Update openapi for 3.5.2danielhanrahan2-3/+3
- 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-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.6mpriyank2-200/+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.1danielhanrahan2-0/+18
- 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 generationegernug1-0/+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 updatempriyank2-588/+588
- 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-06-29Openapi file and RTD updatempriyank2-1262/+1506
- 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 docsmpriyank2-492/+884
- 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-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 processseanbeirne2-436/+658
Issue-ID: CPS-1385 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Ia0b011d4497e7d95f9b625514e8b3216575df044
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 DefinitionsJosephKeenan2-0/+14
-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 mergebmiklos2-396/+423
- 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 openAPIemaclee2-454/+934
- 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-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 Sakoto2-13/+28
* 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.aditya2-268/+258
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-09-23openapi.yaml should not be modified when the application is compiled revertDylanB95EST1-0/+706
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 compiledDylanB95EST1-659/+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>
2021-09-14Create Preliminary Documentation for CPS-Core & NCMPshivasubedi1-0/+659
Create Preliminary documentation for Istanbul release of the CPS-Core. Added new plugins in POM to generate swagger doc for design page. Added latest conf.py file from http://gerrit.onap.org/r/doc Followed template from work done by Chaker here https://wiki.onap.org/display/DW/Component+Documentation+Template Issue-ID: CPS-633 Change-Id: I431776e4d052ec65bf1e1d7709d12d0100592cd5 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: shivasubedi <shiva.subedi@est.tech>