summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2023-06-22Add RTD link to CPS in Release notesToineSiebelink1-2/+4
Issue-ID: REQ-1580 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: I3481703ab6c96b4a12e0804fe04c48c47ffe92ab
2023-04-05Remove docs/conf.yamldanielhanrahan1-25/+0
Change to ONAP pipeline is causing docs-rules job to fail if docs/conf.yaml file exists. So we remove it. Issue-ID: CPS-1596 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: I71528d918b40e24be9c4a893b007b0771890885b
2023-03-20Add sphinxcontirb.spelling extension into conf.pyhalil.cakal2-2/+3
- It also align dmi module with cps for tox.ini config Issue-ID: DOC-798 Change-Id: Ie241f5490243de43fa2889ef88a6dca93702f7a9 Signed-off-by: halil.cakal <halil.cakal@est.tech>
2022-11-07[DMI] Add Basic Auth to OpenAPI DefinitionsJosephKeenan2-1/+8
-Adding basic auth to OpenAPI definitions Issue-ID: CPS-1350 Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Change-Id: I33423ba50683bc76395ddbb8ef7afc1c185bf4b5
2022-10-26Finialise documentation as per doc procedure p02seanbeirne5-33/+88
Issue-ID: CPS-1321 Signed-off-by: seanbeirne <sean.beirne@est.tech> Change-Id: Ibe269a391ac1c519693729b5e505342544913dd1
2022-10-05Bump DMI to 1.2.2-SNAPSHOTmpriyank1-1/+26
- Bump DMI version to 1.2.2-SNAPSHOT Issue-ID: CPS-1325 Change-Id: I12fd5918f196e1f2416e0dd05aaabcda9627689c Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-261.2.1 release notes section DMImpriyank1-0/+24
- release notes section for 1.2.1 dmi plugin Issue-ID: CPS-1302 Change-Id: Ib662896a297409dd3e2ed7b5c35f70f781da8771 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-09-22Update Release Notes for Kohnlukegleeson1-0/+60
Added Jira tickets completed Issue-ID: CPS-1251 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I27ab8420ff4268ddd080a44af70eaeb7cbdd05b5
2022-09-14dmi plugin sync openapi ymlmpriyank2-4/+24
- copy target/generated-sources/swagger/openapi.yaml → docs/api/swagger/openapi.yaml - fixed the tox.ini for the documentation build issue - updated description for topic paramter Issue-ID: CPS-1276 Change-Id: I0771fd6b7a8fda5085a535e02cd40fa49e6b8b6f Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-06-01Async request response dmi -> NCMPJosephKeenan1-1/+1
-Added Async for passthrough running and operational -Build will fail until cps is merged https://gerrit.onap.org/r/c/cps/+/128685 Issue-ID: CPS-830 Change-Id: Iedbfab109f5cd777a5be8eed7414758d0f5ec05c Signed-off-by: JosephKeenan <joseph.keenan@est.tech> Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Signed-off-by: JosephKeenan <joseph.keenan@est.tech>
2022-04-12Merge "Add bounds to sphinx requirement"Toine Siebelink1-1/+3
2022-04-11Add bounds to sphinx requirementCédric Ollivier1-1/+3
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I858cdbfbaf2fab82216cc392ddcff694ee83e2e6
2022-04-11NCMP Kafka Producer Infrastructurempriyank1-0/+3
- Producer configuration and Topic related information. - Accepted topicParameter and request id from NCMP to process async - Replacing Springfox and using Springdoc instead Issue-ID: CPS-829 Change-Id: I369b5ec6c16318220bb218701006918a0bf21419 Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
2022-04-04[dmi-plugin] Fix getResourceDataForPassthroughOperational endpointputhuparambil.aditya1-18/+0
Get endpoint only accepts application/json. Issue-ID: CPS-957 Change-Id: I7b9dd00f293f183dc76623c8e32699e8e90fd17c Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
2022-03-15Create primary documentation for Jakarta releaseBruno Sakoto2-129/+145
* Update release notes * Update openapi documentation Issue-ID: CPS-935 Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca> Change-Id: If63ee52efa505694010c88f3135a71312185b4dc
2022-02-11Update release notesBruno Sakoto1-0/+50
Adding Istanbul releases: * 1.0.2 * 1.0.3 Issue-ID: CPS-891 Change-Id: Ica396a0978f1c618471ac35d85c0ba7c90d5406c Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca>
2022-01-20Align DMI Plugin REST API Specification and Implementationputhuparambil.aditya1-165/+208
Issue-ID: CPS-824 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: If4478f6afd6a36570dc2d800484cffdb40c256c9
2022-01-05dmi-plugin update release notesputhuparambil.aditya1-1/+1
Issue-ID: CPS-841 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: I203ecb51fb90d9efa2d2a56ecfbebb199aa0ea53
2021-12-09Add Examples to DMI-Plugin API Speclukegleeson1-0/+1
Issue-ID: CPS-784 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I02e450c9c14322fa9c9ac3e14807aeebdb4b9e39
2021-12-08Add new features to Release NotesDylanB95EST1-1/+2
Add New Implemented Features to Release Notes for DMI Plugin Issue-ID: CPS-637 Issue-ID: CPS-639 Change-Id: I20a27aa9428ea69fc605f866cadf1b6297e9b9ad Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-11-30Update snapshot version in rtd release notesBruno Sakoto1-1/+1
Issue-ID: CPS-794 Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca> Change-Id: I3b43759e1d43d541735be15d1c938584f0e8d426
2021-11-19Merge "Update release notes for DMI"Toine Siebelink1-0/+44
2021-11-17Update release notes for DMIniamhcore1-0/+44
Issue-ID: CPS-636 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I448430c53b2d8cf7c8a99a9c012964a2230d44b6
2021-11-12Merge "Support Update and Delete operations for DS Passtrough-Running in DMI ↵Toine Siebelink1-107/+52
Plugin"
2021-11-12Support Update and Delete operations for DS Passtrough-Running in DMI PluginDylanB95EST1-107/+52
-Add Update operation for Passthrough Running -Use POST operatiosn for all methods as agrred -refactor to simplify and beter reuse of common methods -add delete operation for passthrough running Issue-ID: CPS-637 Issue-ID: CPS-638 Change-Id: I441181f977dee2bc0be944662465d868595ea452 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-11-08Improve internal documentation linkslukegleeson1-1/+1
Issue-ID: CPS-749 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I0aacfe86234fb56a0edf8b28f1f255d9052048ed
2021-10-21Use intersphinx links for easier release updateToineSiebelink6-16/+16
Issue-ID: CPS-721 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: Id6ba0cb5aafb169caead9dad7c9732b88ff4fcc4
2021-10-12Provide complete openapi.yml in read the docsRenu Kumari4-414/+465
- Seperate openapi.yml for code gen and read the docs - Added few env varaibles in docker-compose.yml Issue-ID: CPS-733 Signed-off-by: Renu Kumari <renu.kumari@bell.ca> Change-Id: Ibda007c40396436a5adce137d9f69806100253dc
2021-10-12Remove redundant documentation imagelukegleeson1-0/+0
Issue-ID: CPS-627 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: Iecb61a97f231b12f5481e693b7b006660b1505e2
2021-10-11Cleanup naming convention for DMI-PluginDylanB95EST5-16/+16
Cleanup naming conventions for DMI-Plugin project. Issue-ID: CPS-627 Change-Id: I6ac542c983870f737760768363ef5764f792a5b7 Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-10-11Merge "Update Release Notes"Niamh Core1-21/+76
2021-10-11Update Release NotesDylanB95EST1-21/+76
Update release notes for DMI Plugin documentation Issue-ID: CPS-627 Change-Id: Ic3f9e36f020e8a5b5dbfaab24c0328cba455a5b9 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech> Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
2021-10-11Merge "Update Overview Section of Documentation"Niamh Core1-8/+1
2021-10-11Merge "Update Deployment Section of DMI Plugin"Toine Siebelink1-3/+47
2021-10-11Update Deployment Section of DMI Pluginniamhcore1-3/+47
Update DMI Plugin Deployment page for Istanbul release Issue-ID: CPS-627 Change-Id: If2d02c689ddf28ae5f14229fe74b00ffcc8d7215 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: niamhcore <niamh.core@est.tech>
2021-10-11Merge "Update Admin Guide"Toine Siebelink1-0/+12
2021-10-11Update Admin Guidelukegleeson1-0/+12
Add Admin Guide for NCMP DMI Plugin as part of finalized documentation Issue-ID: CPS-627 Change-Id: I1d59459147318ad89e7a2a37d5d9ba917e69fc38 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech>
2021-10-11Merge "Update Architecture Page"Toine Siebelink2-12/+27
2021-10-11Update Architecture Pagelukegleeson2-12/+27
Update Architecture Page as part of DMI Plugin Documentation for Istanbul release Issue-ID: CPS-627 Change-Id: I4fb3b082c3d40d5827a4fd73d878eb057c478279 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech>
2021-10-11Merge "Update Index Page"Toine Siebelink1-12/+5
2021-10-11Update Index Pagelukegleeson1-12/+5
Update Index Page as part of DMI Plugin Documentation Issue-ID: CPS-627 Change-Id: Ic1c2724194563fccea3423c4cdf83b8afe23e924 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech>
2021-10-11Merge "Update Design And Modelling section"Niamh Core2-17/+17
2021-10-08Update Design And Modelling sectionlukegleeson2-17/+17
Update Design and Modelling sections of DMI Plugin documentation for Istanbul release. Issue-ID: CPS-627 Change-Id: Ic572da315d23a79a6b0b069e2144e5ff89aff583 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: lukegleeson <luke.gleeson@est.tech>
2021-10-08Update Overview Section of Documentationlukegleeson1-8/+1
Issue-ID: CPS-627 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I13bc511df2894315ad78ae0f3ffd883631529ab2
2021-10-07Updating get module schema request bodyniamhcore2-13/+22
Issue-ID: CPS-706 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I92d241c4ccde77aaaf8aa5a3903437016edf65d0
2021-10-06fix query param to optionstragait2-26/+25
Issue-ID: CPS-678 Signed-off-by: tragait <rahul.tyagi@est.tech> Change-Id: I4ac72da512e2c7883920907137b8834ce20d4528
2021-10-04Merge "Changing resource identifier to a query param"Toine Siebelink2-7/+8
2021-09-30Changing resource identifier to a query paramniamhcore2-7/+8
* Updating yaml * Update jib-maven-plugin version Issue-ID: CPS-679 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: Ie2f49bd8e22723ca4dcd2c20ed39722f22c281c1
2021-09-30Update requirements for doc buildinglukegleeson2-17/+6
Remove unecessary requirements Allow lfdocs-conf to initialise at latest version (0.7.7) It now loads all centralized upper contraints from ONAP doc Issue-ID: CPS-704 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I35e8e32b38229474e2a48ccaf126ab9aa760548f
2021-09-28NCMP no master index label on index documentation pageDylanB95EST1-1/+1
Adding master index label to index page for documentation Issue-ID: CPS-691 Change-Id: Iaab4749902674db2e10868e453a48028fc15cabe Signed-off-by: DylanB95EST <dylan.byrne@est.tech>