Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added proposal for Guilin to wiki page

...

View file
nameDeveloping ONAP API Documentation APR2020.pptx
height150


Proposed ACTION: Create non-functional requirements for Guilin release:

  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

For Background Please See:

...