Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOC-608

Apply common Swagger style and documentation generation tools to create robust ONAP API documentation

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Medium 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).

      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

            eric.debeau eric.debeau
            ajmayer ajmayer
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: