Versions Compared

Old Version 8

changes.mady.by.user Alessandro D'Alessandro

Saved on

compared with

New Version 9

changes.mady.by.user Andy Mayer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added JIRA links for Documenting ONAP APIs

...

  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

  3. Apply Minimum (Phase 1+) swagger guidelines

    1. See: Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
    2. Use the common insert for the info section (e.g., license info, contact info, etc): Swagger Insert Sample for Info Section

Related JIRAs under the Documentation project for the API Documentation non-functional requirements:

Epic: https://jira.onap.org/browse/DOC-608

User Story: https://jira.onap.org/browse/DOC-609

User Story: https://jira.onap.org/browse/DOC-610

User Story: https://jira.onap.org/browse/DOC-611

Business Impact - Enables developers, operators and service providers to use leverage ONAP; Improve integration velocity for API client developers; Ease development handoffs; 

...