When: Web meetings
...
monthly on Friday at 10:00am (Eastern US)
Zoom Bridge: https://zoom.us/j/731954210
...
Goal: Development and Documentation Go Hand-in-hand
...
- Andy Mayer (Modeling Subcommittee)
- Timo Perala (Documentation Project)
- Matthieu Geerebaert (External API Project)
- Adrian OSullivan (External API Project)
- Eric Debeau (Documentation Project)
...
View file name Developing ONAP API Documentation APR2020.pptx height 150
Proposed ACTION: Create non-functional requirements for Guilin release:
Non-Functional Requirement for Guilin: Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key REQ-386
server | ONAP JIRA |
---|---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
serverId | 425b2b0a-557c-3c0c-b515-579789cceedb |
key | REQ-386 |
JIRA Epic: Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key DOC-608
- All components should place externally facing (i.e. interfaces exposed by the ONAP component to either other ONAP components or components external to ONAP) API definitions (e.g. Swagger) in a common path within their Gerrit/Git
Suggested Path: <Component>/docs/api/swagger/Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key DOC-609 - Apply ReDoc to Swagger and place HTML in Readthedocs for the release
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key DOC-610 Apply Minimum (Phase 1+) swagger guidelines
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key DOC-611 - See: Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
- Use the common insert for the info section (e.g., license info, contact info, etc): Swagger Insert Sample for Info Section
...