Organize project tag api-ref by route
This change moves the various api ref entries for project tags to be consistent with other api-ref entries, organized by route. Change-Id: I6ccd9a2878224cfb7357e8ad1ae1aca77de368ef
This commit is contained in:
parent
9c91aa74da
commit
fbd46e3ce7
@ -73,6 +73,100 @@ Example
|
|||||||
:language: javascript
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Modify tag list for a project
|
||||||
|
=============================
|
||||||
|
|
||||||
|
.. rest_method:: PUT /v3/projects/{project_id}/tags
|
||||||
|
|
||||||
|
Modifies the tags for a project. Any existing tags not specified will
|
||||||
|
be deleted.
|
||||||
|
|
||||||
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/projects``
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id_path
|
||||||
|
- tags: response_body_project_tags_required
|
||||||
|
|
||||||
|
Example
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/admin/project-tags-update-request.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
Response
|
||||||
|
--------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- tags: response_body_project_tags_required
|
||||||
|
|
||||||
|
Status Codes
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_status_code:: success status.yaml
|
||||||
|
|
||||||
|
- 200
|
||||||
|
|
||||||
|
.. rest_status_code:: error status.yaml
|
||||||
|
|
||||||
|
- 400
|
||||||
|
- 401
|
||||||
|
- 403
|
||||||
|
- 404
|
||||||
|
|
||||||
|
Example
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
.. literalinclude:: ./samples/admin/project-tags-update-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
|
Remove all tags from a project
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. rest_method:: DELETE /v3/projects/{project_id}/tags
|
||||||
|
|
||||||
|
Remove all tags from a given project.
|
||||||
|
|
||||||
|
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/projects``
|
||||||
|
|
||||||
|
Request
|
||||||
|
-------
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
Response
|
||||||
|
--------
|
||||||
|
|
||||||
|
Status Codes
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. rest_status_code:: success status.yaml
|
||||||
|
|
||||||
|
- 204
|
||||||
|
|
||||||
|
.. rest_status_code:: error status.yaml
|
||||||
|
|
||||||
|
- 400
|
||||||
|
- 401
|
||||||
|
- 403
|
||||||
|
|
||||||
|
|
||||||
Check if project contains tag
|
Check if project contains tag
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
@ -152,64 +246,6 @@ Status Codes
|
|||||||
- 404
|
- 404
|
||||||
|
|
||||||
|
|
||||||
Modify tag list for a project
|
|
||||||
=============================
|
|
||||||
|
|
||||||
.. rest_method:: PUT /v3/projects/{project_id}/tags
|
|
||||||
|
|
||||||
Modifies the tags for a project. Any existing tags not specified will
|
|
||||||
be deleted.
|
|
||||||
|
|
||||||
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/projects``
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- project_id: project_id_path
|
|
||||||
- tags: response_body_project_tags_required
|
|
||||||
|
|
||||||
Example
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
.. literalinclude:: ./samples/admin/project-tags-update-request.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
Response
|
|
||||||
--------
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- tags: response_body_project_tags_required
|
|
||||||
|
|
||||||
Status Codes
|
|
||||||
~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_status_code:: success status.yaml
|
|
||||||
|
|
||||||
- 200
|
|
||||||
|
|
||||||
.. rest_status_code:: error status.yaml
|
|
||||||
|
|
||||||
- 400
|
|
||||||
- 401
|
|
||||||
- 403
|
|
||||||
- 404
|
|
||||||
|
|
||||||
Example
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
.. literalinclude:: ./samples/admin/project-tags-update-response.json
|
|
||||||
:language: javascript
|
|
||||||
|
|
||||||
|
|
||||||
Delete single tag from project
|
Delete single tag from project
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
@ -248,43 +284,6 @@ Status Codes
|
|||||||
- 404
|
- 404
|
||||||
|
|
||||||
|
|
||||||
Remove all tags from a project
|
|
||||||
==============================
|
|
||||||
|
|
||||||
.. rest_method:: DELETE /v3/projects/{project_id}/tags
|
|
||||||
|
|
||||||
Remove all tags from a given project.
|
|
||||||
|
|
||||||
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/projects``
|
|
||||||
|
|
||||||
Request
|
|
||||||
-------
|
|
||||||
|
|
||||||
Parameters
|
|
||||||
~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
|
||||||
|
|
||||||
- project_id: project_id_path
|
|
||||||
|
|
||||||
Response
|
|
||||||
--------
|
|
||||||
|
|
||||||
Status Codes
|
|
||||||
~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. rest_status_code:: success status.yaml
|
|
||||||
|
|
||||||
- 204
|
|
||||||
|
|
||||||
.. rest_status_code:: error status.yaml
|
|
||||||
|
|
||||||
- 400
|
|
||||||
- 401
|
|
||||||
- 403
|
|
||||||
- 404
|
|
||||||
|
|
||||||
|
|
||||||
===============================
|
===============================
|
||||||
Filtering and searching by tags
|
Filtering and searching by tags
|
||||||
===============================
|
===============================
|
||||||
|
Loading…
Reference in New Issue
Block a user