2019-10-25 API Docs Meeting Notes

Date: 

Oct 25, 2019 

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

Agenda / Discussed:

• RECORD: zoom_0.mp4

• Introduction (@Andy Mayer)

• Proposed Style Guide for defining APIs in Swagger (& OpenAPI 3.0) (@Andy Mayer)

  • See: Proposed OpenAPI 2.0 / Swagger Style Guide

  • Add Sample Swagger based on the Style Guide

  • Request 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

Future Topics

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

Zoom Chat Log from Meeting: