-
Epic
-
Resolution: Done
-
Medium
-
None
-
None
-
None
-
Documenting ONAP APIs
-
To Do
Apply common Swagger style and documentation generation tools to create robust ONAP API documentation for externally facing (i.e. interfaces exposed by the ONAP component to either other ONAP components or components external to ONAP) API definitions (e.g. Swagger).
- All components should place externally facing (i.e. interfaces exposed by the ONAP component to either other ONAP components or components external to ONAP) API definitions (e.g. Swagger) in a common path within their Gerrit/Git
- Suggested Path: <Component>/docs/api/swagger/
- Apply ReDoc to Swagger and place HTML in Readthedocs for the release
- Apply Minimum (Phase 1+) swagger guidelines
- See: https://wiki.onap.org/pages/viewpage.action?pageId=81397461
- Use the common insert for the info section (e.g., license info, contact info, etc): https://wiki.onap.org/display/DW/Swagger+Insert+Sample+for+Info+Section
- relates to
-
ONAPARC-593 Guilin-R7 ArchCom Review, DOC-608, (AR-0036-R7-052020) DOC-608 (REQ-386)
- Closed
-
REQ-386 Apply common Swagger style and documentation generation tools to create robust ONAP API documentation
- Done
- mentioned in
-
Page Loading...