openstack/nova
Code Issues Proposed changes

api-ref: os-floating-ip-dns.inc method verification

Browse Source 
Verified the API document with source for methods available
and response codes used.

Part of bp:api-ref-in-rst

Change-Id: Ic462bbdd1f559a89aa43707cf510b6cf621ff4b0
This commit is contained in:
Anusha Unnam 2016-05-11 23:20:35 +00:00
parent 9282b99b8e
commit 6987a1f506
1 changed files with 66 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
api-ref/source/os-floating-ip-dns.inc
View File

@ -1,5 +1,4 @@
.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
@ -20,8 +19,7 @@ Lists registered DNS domains published by the DNS drivers.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
Request
-------
@ -47,8 +45,8 @@ Creates or updates a DNS domain.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: badRequest(400), unauthorized(401),
forbidden(403), notImplemented(501)
Request
-------
@ -80,8 +78,8 @@ Deletes a DNS domain and all associated host entries.
Normal response codes: 202
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Request
-------
@ -94,6 +92,64 @@ Request
Response
--------
List Dns Entries
================
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{ip}
Lists DNS entries for a domain and IP.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- domain: domain
- ip: ip
Response
--------
**Example List Dns Entries: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-list-resp.json
:language: javascript
Find Unique Dns Entry
=====================
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}
Finds a unique DNS entry for a domain and name.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- domain: domain
- name: name
Response
--------
**Example Find Unique Dns Entry: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-get-resp.json
:language: javascript
Create Or Update Dns Entry
==========================
@ -103,8 +159,7 @@ Creates or updates a DNS entry.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
Request
-------
@ -128,35 +183,6 @@ Response
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-resp.json
:language: javascript
Find Unique Dns Entry
=====================
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}
Finds a unique DNS entry for a domain and name.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- domain: domain
- name: name
Response
--------
**Example Find Unique Dns Entry: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-get-resp.json
:language: javascript
Delete Dns Entry
================
@ -166,8 +192,8 @@ Deletes a DNS entry.
Normal response codes: 202
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Request
-------
@ -180,33 +206,3 @@ Request
Response
--------
List Dns Entries
================
.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{ip}
Lists DNS entries for a domain and IP.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- domain: domain
- ip: ip
Response
--------
**Example List Dns Entries: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-list-resp.json
:language: javascript