openstack/neutron-lib
Code Issues Proposed changes

api ref for standard-attr-tag extension

Browse Source 
This updates the API reference for the tag based extensions by adding
details on the standard attr based tags extension as well as noting
the deprecation of the existing tag based extensions.

Change-Id: I849f8e8dc7c89c99f15881446a5c407281e97b77
Partial-Bug: #1706307
This commit is contained in:
Boden R
2017-08-29 12:26:09 -06:00
parent 1c778aa5e6
commit e529fc5d0e
1 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
api-ref/source/v2/tags.inc
View File

@@ -12,15 +12,31 @@ code with 'invalid input for operation' error message.
Tag Extension
=============
.. note::
NOTE: This extension is deprecated in favor of ``standard-attr-tag``.
The ``tag`` extension allows users to set tags on their networks.
This extension supports networks only.
Enhanced Tag Extension
======================
.. note::
NOTE: This extension is deprecated in favor of ``standard-attr-tag``.
The ``tag-ext`` extension allows users to set tags on their resources.
This extension supports subnets, ports, routers, and subnet pools.
Standard Attributes Tag Extension
=================================
The ``standard-attr-tag`` extends tagging support to all resources that support
standard attributes. This includes networks, ports, subnets, subnet pools,
floating IPs, routers, logs, security groups/rules, network segments, QoS
policies and trunks.
Replace all tags
================
@@ -67,7 +83,7 @@ Remove all tags
Removes all tags on the resource.
Normal response codes: 204
Normal response codes: 204
Error response codes: 401, 404
@@ -91,7 +107,7 @@ Confirm a tag
Confirms a given tag is set on the resource.
Normal response codes: 204
Normal response codes: 204
Error response codes: 401, 404
@@ -116,7 +132,7 @@ Add a tag
Adds a tag on the resource.
Normal response codes: 201
Normal response codes: 201
Error response codes: 401, 404
@@ -173,7 +189,7 @@ Remove a tag
Removes a tag on the resource.
Normal response codes: 204
Normal response codes: 204
Error response codes: 401, 404