openstack/nova - nova - OpenDev: Free Software Needs Free Tools

The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.
Note that Neutron publishes to api-ref/network, not networking anymore.
Note that redirects will be set up as well but let's point now to the
new location.
For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html
Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb

There are few needs:body/example/parameter_verification
pending on deprecated APIs. It is not worth to spend time on
completing those.
Removing those todo part and adding note about not updating
them.
Change-Id: I1f2bc4e6d8bdb2b41c4b22c18573a4fc75bea38e

GET /os-security-groups API accept 'all_tenants' [1]
as one of the query param to list all tenants sec groups.
But that is missing in api-ref [2]
..1
e9104dbaef/nova/network/security_group/neutron_driver.py (L178)
e9104dbaef/nova/compute/api.py (L5096)
..2 https://developer.openstack.org/api-ref/compute/#list-security-groups
Closes-Bug: #1734406
Change-Id: I2946f05716c9030f7880ac423cc64b49c04b2992

The 'security_groups' parameter in the GET /os-security-groups API
is not optional and we don't need information about the name
attribute. The "security_groups" parameter being used is actually
for the create server API.
Change-Id: I63bb8fc433b56a3f2b80cfafab37b103fe3a27d9

Change-Id: Ie8dc3252603ce77910e1addb67cdc8844369dfca
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1699732 

Some reference links are out of date.
There's 404 error when trying to access them.
For example:
http://developer.openstack.org/api-ref/networking/
v2-ext/index.html#security-groups-security-groups
Change-Id: Iead6a6f32cdb2c9067bb5425333ad043514edbce

A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.
 - os-cells
 - os-security-groups
 - os-server-groups
 - os-snapshots
 - os-virtual-interfaces
 - os-volume-attachments
 - os-volumes
Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a

make it follow other descriptions, use start from to make
it clear 2.36 is the first microversion deprecate those proxy
Implements: blueprint api-ref-in-rst-ocata
Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367

Proxy APIs are deprecated in microversion 2.36 which means
all proxy APIs will return 404 after 2.35 version.
It will be nice to mention that explicitly in api-ref too.
Partially implements blueprint deprecate-api-proxies
Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82

This fixes the direct links to the security groups, security
group rules and floating IPs (layer 3) extensions in the
neutron api-ref.
Part of blueprint deprecate-api-proxies
Change-Id: Ib2c4ed478714b187fde8b7c42da15cc56b26675e

All proxy APIs are now deprecated which includes
sec grp APIs also.
But list sec grps by server API-
(/servers/{server_id}/os-security-groups) is not
deprecated so this should be separated from deprecated
sec grp APIs in api-ref.
Partially implements blueprint deprecate-api-proxies
Change-Id: I9f9e2cf5f8e390cecd9e1794a0af1a3fcc24f149

As first step to deprecate the proxy APIs,
this commit publish the deprecation of proxy APIs
in api ref doc.
Partially implements blueprint deprecate-api-proxies
Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f

As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c

These methods were already verified in another change. The author forgot to
remove the needs:method_verification line from their change.
See change#314255
Part of bp:api-ref-in-rst
Change-Id: I13fb305f58df0b864bc27db5107601e4ee8842de

Verified the API document with source for methods available and
response codes used.
Part of bp:api-ref-in-rst
Change-Id: Ie3e9e39f5547a3172483b42d21536acf46b445d3

This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93

This fixes the samples references in the security group files,
commenting out 2 that don't exist at all.
This drops the warnings to 145 against current master.
Part of bp:api-ref-in-rst
Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8

In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc

This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26