Copy of 2019-10-25 API Docs Meeting Notes

Date:

08 Nov 2019

NOTE: No call on 1 Nov 2019

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

RECORD:
Introduction (Andy Mayer)
Refine Style Guide for defining APIs in Swagger (Andy Mayer)
- See: Proposed OpenAPI 2.0 / Swagger Style Guide
- Add Sample Swagger based on the Style Guide
- Requested comments by 7 November 2019
Automate publishing Swagger in ReadTheDoc (Eric Debeau) Matthieu Geerebaert
API Validation Tools
- Explore the use of Spectral: https://github.com/stoplightio/spectral

Identify ONAP APIs that are not using Swagger / OpenAPI

Style Guide Review (Andy Mayer)

Automate publishing Swagger in ReadTheDoc (Eric Debeau) Matthieu Geerebaert

Recommendation for use of SwaggerHub, need proposal slide deck

Explore API Validation Tools