Dear ONAP Community,
The Modeling Subcommittee along with the Documentation Project are working
together to help recommend ONAP's approach for developing consistent API
Documentation.
This effort may include:
* Creating a Style Guide for defining APIs in Swagger / OpenAPI 3.0
* Identifying the use of a Swagger/OpenAPI toolset to develop and publish
Swagger / OpenAPI 3.0 API Specs (in JSON or YAML) (e.g., SwaggerHub)
* Selecting a tool for generation of consistent API Reference documentation
directly from Swagger / OpenAPI files (using Redoc for example which creates a
consistent standalone HTML file)
* Creating a structure for common and uniform Conceptual API Documentation,
describing each API and providing quick start with usable TIFY (try it for
yourself) samples
* Start with a common ONAP RST template, instructions, and examples
* Selecting and working with a few ONAP projects to pilot the approach for
Frankfurt
Please consider getting involved to help!
For more background, zoom bridge info, and to sign up for this effort please
see the ONAP wiki page:
https://wiki.onap.org/display/DW/Developing+ONAP+API+Documentation
Best Regards,
Andy
Andy Mayer, Ph.D. | PMTS, Network Cloud and Infrastructure | AT&T Labs | Phone:
+1 (732) 420-9945 | [email protected]<mailto:[email protected]>
[cid:[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#19164): https://lists.onap.org/g/onap-discuss/message/19164
Mute This Topic: https://lists.onap.org/mt/34479477/21656
Group Owner: [email protected]
Unsubscribe: https://lists.onap.org/g/onap-discuss/unsub
[[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
