Description of Use Case / Requirement:

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).

1. 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/
2. Apply ReDoc to Swagger and place HTML in Readthedocs for the release documentation
   • See: https://wiki.onap.org/display/DW/Using+Redoc+to+Generate+API+Reference+Documentation
3. Stretch Goal: 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

Owners (one of these should be the Assignee - use @ notation):

ajmayer

Link to HLD/LLD (if any):

Dependency Relationships with Other Projects:

DOC-608

Project Impact (Test Only (TO), Code (C)):

 Documentation

Support Status for each Affected Project (Supported (S); Partially Supported (P); Not Supported (N)):

Note: for any affected projects labeled 'P' or 'N', please document the resulting gaps.

Integration Leads (use @ notation): 

Company Engagement: 

 AT&T, Orange, Huawei