2020-01-24 API Docs Meeting Notes

Date: 

Jan 24, 2020 at 9:00AM EST (US Eastern)

Next call Jan 24, 2020  Moved 1 hour earlier this week

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

Agenda / Discussed:

• RECORD: zoom_0.mp4

• Introduction (@Andy Mayer)

• Review of Developing ONAP API Documentation Progress (@Andy Mayer)

  • Style Guide: Proposed OpenAPI 2.0 / Swagger Style Guide

  • Style Validation Tool: API Style Validation Tool

  • Generation of Reference Documentation: https://github.com/Redocly/redoc

  • Markdown for Conceptual Documentation: Conceptual API Documentation Structure

  • Pilot with ONAP External API Project (@Adrian OSullivan)

Future Topics

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

Zoom Chat Log from Meeting: