20 Commits

Author SHA1 Message Date
Stephen Finucane
0b1a33ec9c nova-net: Update API reference guide
As highlighted in I77b1cfeab3c00c6c3d7743ba51e12414806b71d2, filtering
either floating IPs or floating IP pools by floating IP name will
actually fallback to filtering by ID. Update the API ref to reflect
this.

Change-Id: I00443ae111cbd1e1ec4d2c2ae1828ddaa095fd1a
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-01-22 13:50:30 +00:00
Monty Taylor
e7cc5efd20 Keep pre-commit inline with hacking and fix whitespace
The flake8 hook for pre-commit installs its own flake8 which is
not what hacking is pinned to. This results in a bunch of errors.
By doing a local hook we can cause these to be the same.

There are flake8 exclusions in tox.ini that need to be used
in pre-commit. Also we should exclude svg files from the whitespace
modifications, because who cares.

Once those are fixed, running pre-commit -a fixes some whitespace
issues. While the normal use isn't to run -a - if someone does make
a patch that touches any of these they'll get erroneous unrelated
errors compared to their lower work - so fix all of the existing
issues, which are mostly space-at-end-of-line issues it seems.

Change-Id: I78e753492e99c03b30a0a691db3bd75ee3d289c9
2019-12-12 14:56:39 +00:00
Andreas Jaeger
dbe6321537 Update api-ref location
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
2019-07-22 19:17:28 +02:00
Takashi NATSUME
f2b2f0e1d4 api-ref: Fix wrong bold decoration
In the 'DELETE /os-floating-ips/{floating_ip_id}' API,
"Error response codes: badRequest(400), unauthorized(401),
forbidden(403)," is bold.
But it should not be bold.
So fix it.

TrivialFix
Change-Id: Ic2d1ae2856406600c9dd3273d21dd2f18e56c1e9
2018-09-25 16:06:57 +09:00
Vu Cong Tuan
605d617d55 Repair links in Nova documentation
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
2017-05-23 17:17:52 +07:00
jichenjc
deac17c4f9 Better wording for micorversion 2.36
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
2016-12-10 18:49:13 +08:00
stewie925
2ecbbd8d43 Complete verification for os-floating-ips
This includes the parameter, example, and body
verification for os-floating-ips.

part of bp:api-ref-in-rst-ocata

Change-Id: I4beff34b41baf77827a2e4d916ad5319bdefbfa1
2016-11-21 14:49:35 -08:00
Ha Van Tu
b5073eb735 [api-ref]: Update link reference
This patch updates link reference for "create keypair" in
Compute API create server [1].
Current reference link:
http://developer.openstack.org/api-ref-compute-v2.1.html#createKeypair
http://developer.openstack.org/api-ref-compute-v2.1.html#createFloatingIP
http://developer.openstack.org/api-ref-compute-v2.1.html#addFloatingIp
http://developer.openstack.org/api-ref-compute-v2.1.html#removeFloatingIp
Update reference link:
http://developer.openstack.org/api-ref/compute/#create-or-import-keypair
http://developer.openstack.org/api-ref/compute
/#create-allocate-floating-ip-address
http://developer.openstack.org/api-ref/compute
/#delete-deallocate-floating-ip-address
[1] http://developer.openstack.org/api-ref/compute/?expanded=
create-server-detail#create-server

Change-Id: I421b559a7c127abb8c8c97d08b579bedb080bbe4
Closes-Bug: #1615948
2016-08-24 09:42:53 +07:00
ghanshyam
b4d0b9a11c Mention proxy API deprecation microversion in api-ref
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
2016-08-01 14:59:53 +09:00
Matt Riedemann
d2bd83bec9 Fix links to network APIs from api-ref
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
2016-07-25 17:13:05 -04:00
ghanshyam
40ea165e81 Publish proxy APIs deprecation in api ref doc
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
2016-06-14 15:31:18 +09:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
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
2016-06-03 08:47:33 -04:00
Pushkar Umaranikar
247cb293e5 api-ref: Method verification for os-floating-ips
Verify and update the response codes for the methods
based on what is in the code.

part of blueprint: api-ref-in-rst

Change-Id: I4049504baa7aa0423337f0f104e3dae9a5e4b37b
2016-05-11 14:16:50 +00:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
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
2016-04-20 16:21:58 -04:00
ghanshyam
ca65bf4e91 Fix sample file path for fixed, floating ips API
This fix sample file path and some satatus code for
-fixed ips
-floating ips

Part of bp:api-ref-in-rst

Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65
2016-04-20 11:05:26 +09:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +00:00
ghanshyam
6f8cda2f39 Fix json response example heading in api ref
Heading for json response example is wrong,
it is json request instead of json response.

Part of bp:api-ref-in-rst

Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:56:20 +09:00
Ken'ichi Ohmichi
05e9f0a0e0 Remove 40X and 50X from Normal response codes
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.

Part of bp:api-ref-in-rst

Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016-04-18 16:56:11 -07:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
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
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
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
2016-04-13 07:34:45 -04:00