Page Information

Title:	Developing ONAP API Documentation
Author:	Andy Mayer	Oct 08, 2019
Last Changed by:	Andy Mayer	Jun 24, 2020
Tiny Link: (useful for email)	https://wiki.onap.org/x/FAtIB
Export As:	Word · PDF

Developer Wiki (48)     Page: Modeling 2020-01-21     Page: 2021-10-14 Doc project meeting     Page: Modeling 2020-01-07     Page: Modeling 2020-05-12     Page: 2021-09-16 Doc project meeting     Page: 2021-09-30 Doc project meeting     Page: 2019-11-13 Doc Project Meeting     Page: 2020-01-23 Doc Project Meeting     Page: 2020-02-20 Doc Project Meeting     Page: Modeling 2020-05-26     Page: 2019-12-05 Doc Project Meeting     Page: 2019-10-17 Doc Project Meeting     Page: Guilin release - non-functional requirements proposed list     Page: 2020-02-27 Doc Project Meeting     Page: 2021-11-25 Doc project meeting     Page: Modeling 2019-11-19     Page: Modeling 2020-05-05     Page: 2020-08-27 Doc project meeting     Page: 2019-10-10 Doc Project Meeting     Page: 2019-11-21 Doc Project Meeting     Page: 2019-10-30 [ExtAPI] Meeting notes     Page: 2020-02-13 Doc Project Meeting     Page: 2019-10-24 Doc Project Meeting     Page: 2020-01-30 Doc Project Meeting     Page: Modeling 2019-10-08     Page: Modeling 2019-12-17     Page: Modeling 2019-10-22     Page: Modeling 2020-04-28     Page: Modeling 2020-01-14 (Prague Meeting)     Page: 2019-11-28 Doc Project Meeting     Page: Modeling 2019-10-29     Page: 2019-12-19 Doc Project Meeting     Page: Modeling 2019-12-03     Page: 2022-01-20 Doc project meeting     Page: Modeling 2019-12-10     Page: 2020-03-05 Doc Project Meeting     Page: 2019-10-31 Doc Project Meeting     Page: 2021-11-04 Doc project meeting     Page: 2021-11-18 Doc project meeting     Page: Modeling 2020-05-19     Page: Modeling 2019-11-26     Page: 2019-12-12 Doc Project Meeting     Page: 2021-09-23 Doc project meeting     Page: Modeling 2019-11-05     Page: 2021-10-07 Doc project meeting     Page: 2021-10-28 Doc project meeting     Page: Modeling 2019-10-15     Page: Modeling 2019-11-12

Parent Page     Page: ONAP R6 Modeling working space

Children (6)     Page: API Style Validation Tool     Page: Conceptual API Documentation Structure     Page: Meeting Notes for Developing API Docs     Page: Proposed OpenAPI 2.0 / Swagger Style Guide     Page: Swagger Insert Sample for Info Section     Page: Using Redoc to Generate API Reference Documentation

There are no labels assigned to this page.

Time	Editor
Jun 24, 2020 14:08	Andy Mayer	View Changes
Added non-functional requirement JIRA
May 22, 2020 14:57	Adrian OSullivan	View Changes
May 20, 2020 14:33	Andy Mayer	View Changes
Added links to JIRA
May 20, 2020 14:30	Andy Mayer	View Changes
May 06, 2020 14:40	Andy Mayer
Added proposal for Guilin to wiki page

External Links (40)
    https://docs.onap.org/en/elalto/guides/onap-developer/how-t…
    https://zoom.us/j/731954210
    https://github.com/felipevicens/osm-visualstudio-extension
    https://wiki.onap.org/pages/viewpage.action?pageId=81397461
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=sdc.git;a=tree;f=docs/sw…
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=externalapi/nbi.git;a=tr…
    https://github.com/openconnectivityfoundation/swagger2doc
    https://github.com/stoplightio/spectral
    https://sourcey.com/spectacle
    https://gerrit.onap.org/r/gitweb?p=externalapi/nbi.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/ves.…
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/invent…
    https://gerrit.onap.org/r/gitweb?p=externalapi/nbi.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=so.git;a=tree;f=docs;hb=…
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=policy/parent.git;a=tree…
    https://gerrit.onap.org/r/gitweb?p=sdc.git;a=tree;hb=HEAD
    https://gerrit.onap.org/r/gitweb?p=sdc.git;a=tree;f=docs;hb…
    https://gerrit.onap.org/r/gitweb?p=policy/parent.git;a=tree…
    https://gerrit.onap.org/r/gitweb?p=so.git;a=tree;f=docs/api…
    https://gerrit.onap.org/r/gitweb?p=so.git;a=tree;f=docs/api…
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://wiki.onap.org/display/DW/Swagger+Insert+Sample+for+…
    https://github.com/Redocly/redoc
    https://gerrit.onap.org/r/gitweb?p=policy/parent.git;a=tree…
    https://gerrit.onap.org/r/gitweb?p=policy/parent.git;a=tree…
    https://gerrit.onap.org/r/gitweb?p=so.git;a=tree;hb=HEAD
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://github.com/swagger-api/swagger-codegen
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=tr…
    https://github.com/swagger-api/swagger-ui
    https://gerrit.onap.org/r/gitweb?p=aai/aai-service.git;a=tr…
    https://gerrit.onap.org/r/gitweb?p=externalapi/nbi.git;a=tr…

Developer Wiki (5)     Page: Conceptual API Documentation Structure     Page: AAI REST API Documentation - Frankfurt     Page: Developing ONAP API Documentation     Page: ExtAPI     Page: API Style Validation Tool