diff options
author | sonu.kumar <sonu.kumar@nectechnologies.in> | 2016-01-28 12:28:49 +0530 |
---|---|---|
committer | Federico Ceratto <federico.ceratto@hpe.com> | 2016-02-04 12:15:48 +0000 |
commit | f65822feeb207b58ef1adc439bbe371735c50f75 (patch) | |
tree | 4ddf24ca7f6d837d103ae3fc4d8a9609d92bb67e | |
parent | 67175e7a1928b281e6e94516fcd77874166cbb14 (diff) | |
download | designate-f65822feeb207b58ef1adc439bbe371735c50f75.tar.gz |
Add docs for PATCH and DELETE call of Zone transfer request
Coses-Bug: #1536932
Change-Id: I634c89eeeb65b4c68c46c24f49f7e5dcc9d8c60a
-rw-r--r-- | doc/source/rest/v2/zones.rst | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/doc/source/rest/v2/zones.rst b/doc/source/rest/v2/zones.rst index 4cc07d11..412aca15 100644 --- a/doc/source/rest/v2/zones.rst +++ b/doc/source/rest/v2/zones.rst @@ -519,6 +519,85 @@ View a Transfer Request } +Update a Transfer Request +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. http: patch:: /zones/tasks/transfer_requests/(uuid:id) + + Update a transfer request. + + This allows a user to update a transfer request before accepting it. + + **Example Request** + + .. sourcecode:: http + + PATCH v2/zones/tasks/transfer_requests/b853202b-22f9-49c1-893d-49cbbf6830bb HTTP/1.1 + Host: 127.0.0.1:9001 + Accept: application/json + Content: application/json + + { + "description": "demo_transfer" + } + + **Example Response** + + ..sourcecode:: http + + HTTP/1.1 200 OK + Content-Length: 476 + Content-Type: application/json + charset=UTF-8 + + { + "status": "ACTIVE", + "target_project_id": dc685ea10a3a4ddfb9bc2deeca66f131, + "zone_id": "08615081-cbfd-445e-9d35-15fccf2be4be", + "links": { + "self": "http://127.0.0.1:9001/v2/zones/tasks/transfer_requests/b853202b-22f9-49c1-893d-49cbbf6830bb" + }, + "created_at": "2016-01-28T04:43:00.000000", + "updated_at": "2016-01-28T04:45:17.000000", + "key": "XWUR5VFL", + "zone_name": "example.com.", + "project_id": "dc685ea10a3a4ddfb9bc2deeca66f131", + "id": "b853202b-22f9-49c1-893d-49cbbf6830bb", + "description": "demo_transfer" + } + + :statuscode 200: Success + :statuscode 202: Accepted + :statuscode 401: Access Denied + + :form description: UTF-8 text field + + +Delete a transfer request +^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. http: delete:: /zones/tasks/transfer_requests/(uuid:id) + + Delete a zone transfer request with the specified id. + + **Example Request** + + .. sourcecode:: http + + DELETE /v2/zones/tasks/transfer_requests/"b853202b-22f9-49c1-893d-49cbbf6830bb HTTP/1.1 + Host: 127.0.0.1:9001 + Accept: application/json + Content: application/json + + **Example Response** + + .. sourcecode:: http + + HTTP/1.1 204 No Content + + :statuscode 204: No Content + + Accept a Transfer Request ^^^^^^^^^^^^^^^^^^^^^^^^^ |