Page History

...

• RECORD: 
• Introduction (Andy Mayer)
• Review of progress
• External API status Adrian OSullivanAndy Mayer
• Phasing of recommended Style Elements Andy Mayer Adrian OSullivan Seshu Kumar Mudiganti
  • Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
  • Once we agree, will define associated Spectral Ruleset
  • Phased activities: (e.g., Minimum 1, 2, & 3 Guilin; 4 & 5 Stretch goals)
    1. All components should place externally facing API definitions (e.g. Swagger) in a common path within their Gerrit/Git 
       1. Suggested Path: <Component>/docs/api/swagger/
    2. Apply ReDoc to Swagger and place UML HTML in Readthedocs for the release.
    3. Apply Minimum (Phase 1+) swagger guidelines
       1. Use common insert for Info section template
    4. Use embedded markdown for conceptual documentation
    5. Apply full swagger guidelines.
• Discussion new effort on enhancing SO APIs. (Andy Mayer Seshu Kumar Mudiganti)
• Preparation of readout to PLTs and TSC (plan to present to TSC on April 9th)
  • 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 that are available 

...