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
This commit is contained in:
Sean Dague
@@ -28,7 +28,7 @@ Associates host with and disassociates host from a network.
|
||||
List Networks
|
||||
=============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-networks
|
||||
.. rest_method:: GET /os-networks
|
||||
|
||||
Lists networks for the project.
|
||||
|
||||
@@ -39,13 +39,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@@ -57,7 +50,7 @@ Response
|
||||
Create Network
|
||||
==============
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks
|
||||
.. rest_method:: POST /os-networks
|
||||
|
||||
Creates a network.
|
||||
|
||||
@@ -72,10 +65,6 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), confli
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
**Example Create Network: JSON request**
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-networks/network-create-req.json
|
||||
@@ -92,7 +81,7 @@ Response
|
||||
Add Network
|
||||
===========
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks/add
|
||||
.. rest_method:: POST /os-networks/add
|
||||
|
||||
Adds a network to a project.
|
||||
|
||||
@@ -107,10 +96,6 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), NotImp
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
**Example Add Network: JSON request**
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-networks/network-add-req.json
|
||||
@@ -122,7 +107,7 @@ Response
|
||||
Show Network Details
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-networks/{network_id}
|
||||
.. rest_method:: GET /os-networks/{network_id}
|
||||
|
||||
Shows details for a network.
|
||||
|
||||
@@ -138,7 +123,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
|
||||
Response
|
||||
@@ -152,7 +136,7 @@ Response
|
||||
Delete Network
|
||||
==============
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/os-networks/{network_id}
|
||||
.. rest_method:: DELETE /os-networks/{network_id}
|
||||
|
||||
Deletes a network.
|
||||
|
||||
@@ -169,7 +153,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
|
||||
Response
|
||||
@@ -180,7 +163,7 @@ There is no body content for the response of a successful DELETE query.
|
||||
Associate Host (DEPRECATED)
|
||||
===========================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action
|
||||
.. rest_method:: POST /os-networks/{network_id}/action
|
||||
|
||||
.. warning::
|
||||
This API is only available with ``nova-network`` which is
|
||||
@@ -203,7 +186,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
- associate_host: associate_host
|
||||
|
||||
@@ -220,7 +202,7 @@ There is no body content for the response of a successful POST query.
|
||||
Disassociate Network (DEPRECATED)
|
||||
=================================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action
|
||||
.. rest_method:: POST /os-networks/{network_id}/action
|
||||
|
||||
.. warning::
|
||||
This API is only available with ``nova-network`` which is
|
||||
@@ -243,7 +225,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
|
||||
**Example Disassociate Network: JSON request**
|
||||
@@ -259,7 +240,7 @@ There is no body content for the response of a successful POST query.
|
||||
Disassociate Host (DEPRECATED)
|
||||
==============================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action
|
||||
.. rest_method:: POST /os-networks/{network_id}/action
|
||||
|
||||
.. warning::
|
||||
This API is only available with ``nova-network`` which is
|
||||
@@ -282,7 +263,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
|
||||
**Example Disassociate Host from Network: JSON request**
|
||||
@@ -299,7 +279,7 @@ There is no body content for the response of a successful POST query.
|
||||
Disassociate Project (DEPRECATED)
|
||||
=================================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action
|
||||
.. rest_method:: POST /os-networks/{network_id}/action
|
||||
|
||||
.. warning::
|
||||
This API is only available with ``nova-network`` which is
|
||||
@@ -322,7 +302,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- network_id: network_id
|
||||
|
||||
**Example Disassociate Project from Network: JSON request**
|
||||
|
||||
Reference in New Issue
Block a user