openstack/designate
Code Issues Proposed changes

Add v1 API deprecation warnings

Browse Source 
Also add warnings on the different use of "description" fields in API V1 VS V2

Change-Id: Ie02fe85133d083570d7b6633fdaa84614c77f78a
Closes-Bug: 1466568
This commit is contained in:
Federico Ceratto 2015-07-02 18:03:27 +01:00
parent 15cf07a48e
commit 76d27ad25c
3 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/rest.rst
View File

@ -63,6 +63,8 @@ API Versions
The API has 2 versions - V1 and V2.
.. note:: V1 has been deprecated since the Kilo release.
V1 API
------
.. toctree::

7
doc/source/rest/v1/records.rst
View File

@ -5,6 +5,13 @@ Resource record entries are used to generate records within a zone
TODO: More detail.
.. note:: V1 API has been deprecated since the Kilo release.
.. note:: The "description" field on Records cannot be accessed from the V2
API. Likewise, the "description" field on Record Sets cannot be accessed
from the V1 API.
Create Record
-------------

4
doc/source/rest/v2/recordsets.rst
View File

@ -27,6 +27,10 @@ The following illustrates a record set in the BIND file format:
20 mail2.example.org.
30 mail3.example.org.
.. note:: The "description" field on Records cannot be accessed from the V2
API. Likewise, the "description" field on Record Sets cannot be accessed
from the V1 API.
Create Record Set (A, AAAA, CNAME, NS, and TXT)
-----------------------------------------------