You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 11
Next »
When: Web meetings weekly on Friday at 10:00am (Eastern US)
Goal: Development and Documentation Go Hand-in-hand
From Writing API Documentation -> Developing API Documentation
Make it easy to create by designers and developers
Make it easy to access and relevant to developers
Make it easy to use: Sample Calls and Code are essential
Try It For Yourself (TIFY) Examples
Panes on page with prose, sample code, and navigation / search
Keep simple and easy to understand
Copy and paste friendly
Target languages (and code generation)
Team (please add your name below to sign up)
For Background Please See:
![](/rest/documentConversion/latest/conversion/thumbnail/71830320/1)
The API Documentation Factory
![](/download/attachments/71830292/image2019-10-10_10-13-58.png?version=1&modificationDate=1570716839000&api=v2)
Approach and Steps
Modeling Subcommittee along with the Documentation Project will discuss and recommend to the TSC a common API Documentation approach for ONAP.
Style Guide for defining APIs in Swagger / OpenAPI 3.0
Start with a common ONAP RST template, instructions, and examples
Select and work with a few ONAP projects to pilot the approach for Frankfurt (e.g., External API, SO, etc.)
- No more maintained. Do not cover full OpenAPI specifications
Existing ONAP Documentation