aboutsummaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
AgeCommit message (Collapse)AuthorFilesLines
2020-04-16WIP: add embedded ReDoc documentation for APIEric Debeau12-0/+62
Include ReDoc using embedded JavaScript capabilities in RST Create a new directory 'redoc' to store - <api>.rst to embed RST content for each API - <api>.js to store link towards the JSON Swagger file for each API - redoc.js to store JS links to render ReDoc Modify offeredapis.rst to include a new section Issue-ID: EXTAPI-433 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Iaa2430a7d4080ed6f91ec8a3e2d6203319f29425
2020-04-08Automation adds externalapi-nbi-offeredapis.rstLF Jenkins CI1-53/+54
Issue-ID: CIMAN-376 Change-Id: I112e29458eeba1ea3e8376224bb6d9dc38ee25cd Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-02-28Add index html and update remaining swagger for NBIaosull0111-285/+1407
Issue-ID: EXTAPI-402 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I5746fd31f14c106bb85983af987ef0e71910e20d
2020-02-19This is to update swagger as per ONAP style guidelinesaosull016-576/+2143
Issue-ID: EXTAPI-397 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I1d3f2e330cf69102e3f20340b9e073f000dca5ed
2020-02-05Update Service Catalog Swagger with Markdownaosull012-738/+621
Issue-ID: EXTAPI-386 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: Id4969b1472740623ce7051b0bc5ef5a94b841748
2020-01-22Fix Spectral error and add https schemeaosull0110-5/+14
Issue-ID: EXTAPI-385 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I1856385dc95b7b2ca6c24daabbd37a10a9f29621
2020-01-14Update Service Order swagger for E2E Network Slicing use casedhebeha2-0/+7
Issue-ID: EXTAPI-381 Change-Id: Ia96e26c850688ea5129e1f03b854594ba8e15f93 Signed-off-by: dhebeha <dhebeha.mj71@wipro.com>
2020-01-14update swagger based on spectral scansaosull0110-78/+113
Issue-ID: EXTAPI-378 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I3f9b27f67e19f25d92a1383a398a817ab51e8358
2020-01-07Update other swaggers as per guidelinesaosull018-47/+127
Issue-ID: EXTAPI-357 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I906f81722074c9a679ac6048e544e884646ed760
2019-12-20Removed additional tag in service catalog swagger as per suggested guidelinesajmayer1-1/+1
Change-Id: Ibdce212337c1b8ebb0e4d27c46c394742f46635b Signed-off-by: ajmayer <am803u@att.com> Issue-ID: EXTAPI-374
2019-12-18Update service catalog swagger as per suggested guidelines.aosull012-13/+34
Issue-ID: EXTAPI-374 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: I9633cf2dab7f312e67b022937f55da7f7b03071f
2019-11-29Update Service Catalog swagger to El Altoaosull012-35/+245
Issue-ID: EXTAPI-327 Signed-off-by: aosull01 <adrian.osullivan@huawei.com> Change-Id: Idf7e594d51fd5805580901c589ffd6ee08c32eee
2019-10-14Update with El Alto releaseEric Debeau1-23/+48
Correct some DOC8 errors Issue-ID: EXTAPI-338 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I79cdf25425573b25562814a3f4da36526d156a26
2019-09-04Improve license scan resultMatthieu Geerebaert15-0/+230
Update pom.xml with new extension for mvn license:check and license:format Change-Id: Ib3fb1334178f4e4700b84c59f4a2af928b8f6207 Issue-ID: EXTAPI-306 Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
2019-08-13Update Swagger API version to 4.0.1aosull0115-20/+20
Change-Id: If47b948e979d614022c079d567af12d8997f6e6f Issue-ID: EXTAPI-277 Signed-off-by: aosull01 <adrian.osullivan@huawei.com>
2019-04-29CCVPN (East-west Interface)Vodafone1-0/+22
Issue-ID: EXTAPI-233 Co-authored-by: madhuri.verma@vodafone.com Signed-off-by: Vodafone <onap@vodafone.com> Change-Id: I41edf2847605395d079241e60f2f21005c72fb2b
2019-04-23Documentation improvementromaingimbert4-1019/+894
-add target parameter -change pdf Change-Id: I43f033bb51484e9d2c18a698272b5ebf88696f64 Issue-ID: EXTAPI-169 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
2019-04-02Update NBI version to 4romaingimbert1-6/+6
-change nbi version to 4.0.0 -change path to v4 Change-Id: Idc35e25fa13625b0916909d5030fcb458561a3fa Issue-ID: EXTAPI-220 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
2019-03-22Documentation improvementromaingimbert4-3/+18
-add documentation from dublin -change pdf Change-Id: I18c1356a862eac851f46ff12348ec268fd615127 Issue-ID: EXTAPI-169 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
2019-03-12Update Swagger filesMatthieuGeerebaert42-16829/+6351
Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2 Issue-ID: EXTAPI-211 Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
2019-02-12Update documentation for Get service/{id}aosull011-7/+6
Change-Id: Iaf1ef3fe00692000122787f92c37424a9afa6ab9 Issue-ID: EXTAPI-200 Signed-off-by: aosull01 <adrian.osullivan@huawei.com>
2018-11-29Update documentation for releaseMatthieuGeerebaert1-0/+0
Update nbicallflow.pdf Update release date Update version from 3.0.0 to 3.0.1 Issue-ID: EXTAPI-163 Change-Id: Ibbebcdbd896d000d29a9d92230a1481168241853 Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
2018-11-26Update nbicallflowEric Debeau1-0/+0
Update nbicallflow.pdf to be aligned with Casablanca API Issue-ID: EXTAPI-163 Change-Id: Ia1dd1ccdd1c165eeb84c3ee97a65c5124a2cb9e6 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-19Update OfferedAPI sectionEric Debeau2-1/+63
Add links to listener swagger Add swagger for healthCheck Change-Id: I46d580e6d589686441ac899ebfa3c397d3464f62 Issue-ID: EXTAPI-163 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-11-10Update doc - API sectionEric Debeau2-356/+189
Remove index.rst offeredapi.rst - Modify the title - Correct DOC8 errors - Minor editorial corrections - Use ** for ONAP components - Uee `` for code Issue-ID: EXTAPI-163 Change-Id: Ie9c353b0770bbdc75a38cc05b757b1f8f5028c4c Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-10-19Update docMatthieuGeerebaert7-4034/+0
- Remove old swagger - Update shcemas Change-Id: I8a262aab82c3fc55e60b6d570999b569d908d62a Issue-ID: EXTAPI-163 Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
2018-09-14Add API Documentation for Casablancaromaingimbert36-221/+10056
-update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
2018-09-11Add API Documentation for Casablancaromaingimbert12-31/+103
-change docs Change-Id: I1ed30a0c329951aa7c20b752ccbcbf07ad640afd Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
2018-05-09Correct bad spelling wordsEric Debeau1-5/+5
Correct bad spelling words based on the results provided by the tox -espellcheck command from Documentation project Change-Id: If2ebfce04b7cd65f418feb9775385a36c8242dbb Issue-ID: EXTAPI-85 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-04-26correct some rst filesRene Robert1-13/+13
Issue-ID: EXTAPI-74 Change-Id: Iafe3a129da0059cc666f30644ea914b1d576a00f Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-26correct rst filesRene Robert2-20/+19
Issue-ID: EXTAPI-74 Change-Id: Ib03bdda0f7f8493d3b3b6cac9f603076bc7bf62b Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-23correct links and add infosRene Robert1-0/+0
Issue-ID: EXTAPI-74 Change-Id: Ic219585f889ca9c5fb03e1452c2583753e517d39 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-23Merge "add licence to files Issue-ID: EXTAPI-74"Andy Mayer15-0/+69
2018-04-23add info in docRene Robert1-0/+194
Issue-ID: EXTAPI-74 Change-Id: Iebea5ef0fa56ae0c9c11babdc108acc9b3ee0e40 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-23add licence to filesRene Robert15-0/+69
Issue-ID: EXTAPI-74 Change-Id: I6857f89ce5529cf1f446f64dbb46573e009886dc Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-20nbi doc updateRene Robert19-81/+37
Issue-ID: EXTAPI-74 Change-Id: Iedf3bad3ac690a3e2e2ffbb77bff6bc5aee20323 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-10Add license in missing doc filesEric Debeau15-0/+69
Change-Id: Icf04d9f25ae2679fbfd97e0930887370225b6ec6 Issue-ID: EXTAPI-53 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
2018-04-06correct link to DevDocRene Robert1-2/+1
Issue-ID: EXTAPI-48 Change-Id: Ib78887cc4eb81dcc15004b22a184120f21d03fdc Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-04-04correct DOC8 problemsRene Robert1-201/+198
Issue-ID: EXTAPI-45 Change-Id: Ief5f2d7d0bddb2ca199031762ff488392556bb34 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-29correct filename/linkRene Robert1-1/+1
Issue-ID: EXTAPI-43 Change-Id: I62f768d7ffb595c69a02ad27515b2e26907f0d64 Signed-off-by: Rene Robert <rene.robert@orange.com>
2018-03-28add API documentationsRene Robert28-0/+12329
Issue-ID: EXTAPI-40 Change-Id: If700a2e2700f7c19e22c8f5d11ddf425eb0075a5 Signed-off-by: Rene Robert <rene.robert@orange.com>