summaryrefslogtreecommitdiffstats
path: root/docs/api
AgeCommit message (Collapse)AuthorFilesLines
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>
2021-09-14Create Preliminary Documentation for CPS-Core & NCMPshivasubedi2-412/+1218
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>
2021-09-01Add ncmp endpoints to swagger-uiRenu Kumari1-1/+3
- added ncmp-enpoints to swagger-ui - removed springfox dependencies - removed Docket configuration as we are loading ui from openapi.yml - removed endpoints which are not implemented - Fixed ncmp basepath as per CPS-616 Issue-ID: CPS-601 Issue-ID: CPS-616 Signed-off-by: Renu Kumari <renu.kumari@bell.ca> Change-Id: I03c7789f48a12d3ffd5fcb934d7ba6347d4044e4
2021-07-13Editing of Nordix Licenses to ONAP guidelineslukegleeson1-0/+1
Issue-ID: CPS-489 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I415534515b3d8325f41d5dc1d02c6e0ae70c6cf1
2021-06-18Missing licence info added in pom fileshivasubedi1-0/+17
- Added licence info to files that were missing it - Fixed licence info to match with the creator of the file Issue-ID: CPS-467 Signed-off-by: shivasubedi <shiva.subedi@est.tech> Change-Id: I1c0eaedb2c87743a61a1cd58f33b0d0d04b3a977
2021-03-02CPS-265 - updating cps path to support include-descendants option.niamhcore1-0/+7
Issue-ID: CPS-265 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I9e9b84760dbc8b5eb4b31ab972fdb2d186c6bb48
2021-02-25Publish openapi.yml for docsRishi.Chail1-0/+813
Issue-ID: CPS-176 Signed-off-by: Rishi.Chail <rishi.chail@est.tech> Change-Id: I77251a86e2a7816a5c97d7295b2d8cda68e46f28