openstack/deb-python-neutron-lib
Code Issues Proposed changes

api-ref: introduced a stub sub-page to cover general info

Browse Source 
Apart from specifics of features like L2 or L3 or QoS API, there should
be a separate place to contain general information about how to use
Neutron API. This patch introduces an empty stub sub-page for just that.
Follow-up patches will expand with details.

Things like sorting and pagination behaviour, or authentication, or
headers, are good candidates for this sub-page, because they are in most
cases not resource specific but cover the whole Neutron API. It's better
to keep those details in a single place instead of duplicating the
information for each new resource.

Change-Id: Ib04b18bf9e872fd2471a7f3dda3853349063761a
This commit is contained in:
Ihar Hrachyshka
2016-08-27 18:57:33 +00:00
parent f38db62041
commit ba7dee0bfd
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/source/v2/index.rst
View File

@@ -6,6 +6,7 @@ Networking API v2.0
.. rest_expand_all:: .. rest_expand_all::
.. include:: intro.inc
.. include:: versions.inc .. include:: versions.inc
.. include:: extensions.inc .. include:: extensions.inc
.. include:: networks.inc .. include:: networks.inc

13
api-ref/source/v2/intro.inc Normal file
View File

@@ -0,0 +1,13 @@
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=========
API guide
=========
This section introduces readers to OpenStack Networking (v2) API, providers
guidelines on how to use it, and describes common features available to users
throughout all Networking APIs.