summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorsonu.kumar <sonu.kumar@nectechnologies.in>2016-06-10 14:44:49 +0530
committersonu.kumar <sonu.kumar@nectechnologies.in>2016-06-13 09:21:01 +0530
commit6bcc95d106cb947f4a052ec3568a10c822c37c68 (patch)
tree145d5fbd0f9cc704ae392f91abbe06a13e9a223b /api-ref
parente93bd9d81e6ac89060b527d9e9e6480b07d75025 (diff)
downloaddesignate-6bcc95d106cb947f4a052ec3568a10c822c37c68.tar.gz
Add docs for zone ownership transfer_accept API
Change-Id: Ic544254cecc4d872361f90d471200ba74602488b depends-on: I3dc042f666be43649bb3dec6e92cc67d1c32578f
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc48
-rw-r--r--api-ref/source/parameters.yaml7
-rw-r--r--api-ref/source/samples/zones/list-zone-transfer-accept-response.json37
3 files changed, 92 insertions, 0 deletions
diff --git a/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc b/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
index 078665a8..d759a007 100644
--- a/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
+++ b/api-ref/source/dns-api-v2-zone-ownership-transfer-accept.inc
@@ -94,3 +94,51 @@ Response Example
.. literalinclude:: samples/zones/create-zone-transfer-accept-response.json
:language: javascript
+
+
+List Zone Transfer Accepts
+===========================
+
+.. rest_method:: GET /v2/zones/tasks/transfer_accepts
+
+This will list all your accepted ownership transfer.
+
+Normal response codes: 200
+
+Error response codes: 405,404,403,401,400,503
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+ - x-auth-token: x-auth-token
+ - x-auth-all-projects: x-auth-all-projects
+ - x-auth-sudo-project-id: x-auth-sudo-project-id
+ - status: zone_transfer_accept_status_filter
+
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+ - x-openstack-request-id: x-openstack-request-id
+ - id: zone_transfer_accept_id
+ - project_id: project_id
+ - status: zone_transfer_request_status
+ - zone_id: zone_transfer_request_id
+ - key: zone_transfer_request_key
+ - created_at: created_at
+ - updated_at: updated_at
+ - zone_transfer_request_id: zone_transfer_request_id
+ - links: links
+ - metadata: metadata
+
+
+Response Example
+----------------
+
+.. literalinclude:: samples/zones/list-zone-transfer-accept-response.json
+ :language: javascript
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 55718de3..4c14e949 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -317,6 +317,13 @@ zone_status_filter:
required: false
type: string
+zone_transfer_accept_status_filter:
+ description: |
+ Filter results to only show ``zone_transfer_accepts`` that have a ``status`` matching the filter
+ in: query
+ required: false
+ type: string
+
zone_transfer_request_status_filter:
description: |
Filter results to only show ``zone_transfer_requests`` that have a ``status`` matching the filter
diff --git a/api-ref/source/samples/zones/list-zone-transfer-accept-response.json b/api-ref/source/samples/zones/list-zone-transfer-accept-response.json
new file mode 100644
index 00000000..24b13040
--- /dev/null
+++ b/api-ref/source/samples/zones/list-zone-transfer-accept-response.json
@@ -0,0 +1,37 @@
+{
+ "metadata": {
+ "total_count": 2
+ },
+ "links": {
+ "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts"
+ },
+ "transfer_accepts": [{
+ "status": "COMPLETE",
+ "zone_id": "8db93d1a-59e3-4143-a393-5821abea0a46",
+ "links": {
+ "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts/afb4222b-18b3-44b3-9f54-e0dfdba1be44",
+ "zone": "http://127.0.0.1:9001/v2/zones/8db93d1a-59e3-4143-a393-5821abea0a46"
+ },
+ "created_at": "2016-06-01 05:35:35",
+ "updated_at": "2016-06-01 05:35:35",
+ "key": null,
+ "project_id": "85604ecfb5334b50bd40ca53fc1d710f",
+ "id": "afb4222b-18b3-44b3-9f54-e0dfdba1be44",
+ "zone_transfer_request_id": "d223f7ef-77a6-459e-abd3-b4dbc97338e7"
+ },
+ {
+ "status": "COMPLETE",
+ "zone_id": "925bfc45-8901-4aca-aa12-18afaf0879e2",
+ "links": {
+ "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_accepts/ecbc7091-c498-4ec4-9893-68b06297fe50",
+ "zone": "http://127.0.0.1:9001/v2/zones/925bfc45-8901-4aca-aa12-18afaf0879e2"
+ },
+ "created_at": "2016-06-01 10:06:36",
+ "updated_at": "2016-06-01 10:06:37",
+ "key": null,
+ "project_id": "85604ecfb5334b50bd40ca53fc1d710f",
+ "id": "ecbc7091-c498-4ec4-9893-68b06297fe50",
+ "zone_transfer_request_id": "94cf9bd3-4137-430b-bf75-4e690430258c"
+ }
+ ]
+}