2020-03-06 API Docs Meeting Notes

Date:

Mar 6, 2020 at 9:00AM EST (US Eastern)

Note new time is 9:00AM Eastern US.

Meeting Link: https://zoom.us/j/731954210

RECORD:
Introduction (@Andy Mayer)
Review of progress
External API status @Adrian OSullivan@Andy Mayer
Phasing of recommended Style Elements @Andy Mayer
- Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
- Once we agree, will define associated Spectral Ruleset
Discussion on which ONAP APIs to work with next. (@Andy Mayer)
Preparation of readout to PLTs and TSC
- The big picture
- Example from External API (before and after)
- Start smaller
  - Placement of Swagger files in Gerrit/Git
  - Use of Redoc for API documentation
  - Application of Phase 1 Style
  - Tools

Identify ONAP APIs that are not using Swagger / OpenAPI

Automate publishing Swagger in ReadTheDoc (@Eric Debeau) @Matthieu Geerebaert

Possible recommendation for use of SwaggerHub, need proposal slide deck

Explore API Catalog / Library Tools