openstack
/
openstack-manuals
Code Issues Proposed changes

Merge "Adds info about service naming and api-ref directory/URL"

This commit is contained in:
Jenkins 2016-08-16 14:52:04 +00:00 committed by Gerrit Code Review
parent e4ae7b3900 b719e363cc
commit 350c223912
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/contributor-guide/source/api-guides.rst
View File

@ -37,6 +37,13 @@ Standards for API reference in OpenStack
The API working group has `API documentation guidelines`_ that all teams
providing a REST API service in OpenStack strive to follow.
For service names, you must adhere to the official name for the service as
indicated in the governance repository in the ``reference/projects.yaml``
file. These names are used in the URL for the documentation by stating the
target directory for the content in the ``api-ref-jobs:`` indicator. If
your service does not have a name indicated in the governance repo,
please ask your PTL or a Technical Committee member how to proceed.
.. _how-to-document-api:
How to document your OpenStack API service