diff options
author | Graham Hayes <graham.hayes@hpe.com> | 2016-05-16 18:46:17 +0100 |
---|---|---|
committer | Graham Hayes <graham.hayes@hpe.com> | 2016-05-16 18:46:17 +0100 |
commit | 9bc1a804cb5fe79ebe0c19a7cc2dd62522e2283a (patch) | |
tree | f0fb5e66751271902761ba1098cdccdee3c428d0 /api-ref | |
parent | 773528d7ca2cd7ef53db32655e661414634922d5 (diff) | |
download | designate-9bc1a804cb5fe79ebe0c19a7cc2dd62522e2283a.tar.gz |
Add "/" to API-Ref Docs
Change-Id: I9e98219a359b7bbf59fbf9b8473dbd0bcfb719af
Diffstat (limited to 'api-ref')
-rw-r--r-- | api-ref/source/dns-api-v2-version.inc | 37 | ||||
-rw-r--r-- | api-ref/source/index.rst | 1 | ||||
-rw-r--r-- | api-ref/source/samples/versions/get-versions-response.json | 26 |
3 files changed, 64 insertions, 0 deletions
diff --git a/api-ref/source/dns-api-v2-version.inc b/api-ref/source/dns-api-v2-version.inc new file mode 100644 index 00000000..97ac0729 --- /dev/null +++ b/api-ref/source/dns-api-v2-version.inc @@ -0,0 +1,37 @@ +============ +API Versions +============ + +Show all enabled API versions + +List all API versions +===================== + +.. rest_method:: GET / + + +Normal response codes: 200 + +Error response codes:405,404,403,401,400,503, + + +Request +------- + +No parameters needed + +Response Parameters +------------------- + +.. rest_parameters:: parameters.yaml + + - x-openstack-request-id: x-openstack-request-id + + +Response Example +---------------- + +.. literalinclude:: samples/versions/get-versions-response.json + :language: javascript + + diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index ade4cdb0..e09ce178 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -6,6 +6,7 @@ .. rest_expand_all:: +.. include:: dns-api-v2-version.inc .. include:: dns-api-v2-zone.inc .. include:: dns-api-v2-zone-import.inc .. include:: dns-api-v2-zone-export.inc diff --git a/api-ref/source/samples/versions/get-versions-response.json b/api-ref/source/samples/versions/get-versions-response.json new file mode 100644 index 00000000..3c961549 --- /dev/null +++ b/api-ref/source/samples/versions/get-versions-response.json @@ -0,0 +1,26 @@ +{ + "versions": { + "values": [ + { + "id": "v1", + "links": [ + { + "href": "http://127.0.0.1:9001/v1", + "rel": "self" + } + ], + "status": "DEPRECATED" + }, + { + "id": "v2", + "links": [ + { + "href": "http://127.0.0.1:9001/v2", + "rel": "self" + } + ], + "status": "CURRENT" + } + ] + } +} |