...

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

Documenting ONAP APIs

Key Contacts -  Andy Mayer

Guilin Proposed Requirements 

Also see: Developing ONAP API Documentation

Executive Summary - Improve ONAP API Documentation:

• Developer Friendly
• Non-Developer Friendly
• Easy to Find & Easy to Navigate
• Common and Uniform Documentation Structure and Approach
• Provides Information on Using the API (e.g., quick start)
• Try It For Yourself (TIFY) Examples

Proposed non-functional requirements for Guilin release:

1. 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/
2. Apply ReDoc to Swagger and place HTML in Readthedocs for the release

3. Apply Minimum (Phase 1+) swagger guidelines

   1. See: Proposed Phase 1+ OpenAPI 2.0 / Swagger Style Guide
   2. Use the common insert for the info section (e.g., license info, contact info, etc): Swagger Insert Sample for Info Section

Business Impact - Enables developers, operators and service providers to use leverage ONAP; Improve integration velocity for API client developers; Ease development handoffs; 

Business Markets - All  developers,operators and service providers can leverage ONAP APIs 

Funding/Financial Impacts - Reduction in development and integration expense from using well defined open Interfaces.

Organization Mgmt, Sales Strategies -There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.