Building standard OpenStack API interface documentation

Source: Internet
Author: User

1. Building API Interface Documentation Standard Reference:

Http://docs.openstack.org/contributor-guide/api-guides.html

2. To build the API interface documentation step, refer to the patch below:

https://review.openstack.org/#/c/361791/

https://review.openstack.org/#/c/305870/

https://review.openstack.org/#/c/305973/

3. How the CI that created the API interface document has been published to the OpenStack website.

(1) Create ci:https://review.openstack.org/#/c/305464/

(2) Release into html:https://review.openstack.org/#/c/305485/

4. Other issues.

(1) from the Project-config project, are you sure only Nova is doing this?

Other projects, such as Magnum,senlin, are also making API documentation standard specifications.

(2) What is openstack/openstack-manuals doing?

There is only one link to: http://developer.openstack.org/api-ref.html

(3) What is Openstack/api-site doing?

All project Api-ref have been migrated to their own projects, so the future project Api-ref only need to be maintained within the Karbor project.

(4) Swagger is a way to define the API based on YAML, Karbor design is swagger, but not the standard specification of OpenStack.

Http://editor.swagger.io/#/?import=http:%2F%2Ffpaste.org%2F324841%2F81061214%2Fraw%2F

Building standard OpenStack API interface documentation

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.