2019-12-13 API Docs Meeting Notes

Date:

Dec 13, 2019

Next call Jan 24, 2020

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
- Readout to PTL team next Monday
- Add Sample Swagger based on the Style Guide
- Requested comments from TM Forum by 31 December 2019
Automate publishing Swagger in ReadTheDoc (@Eric Debeau) @Matthieu Geerebaert
API Validation Tools
- Explore the use of Spectral: https://github.com/stoplightio/spectral
- Another tool from OSM: https://github.com/felipevicens/osm-visualstudio-extension

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