23 Commits

Author SHA1 Message Date
Michael Johnson
39652d7a51 Add simple API versioning to the Designate API
Adds simple API versioning for Designate. Designate API minor releases are
additive to the API major revision and share the same URL path. Subsequent
minor versions are a superset of the previous versions of the same major
revision.
Updates the version discovery document to be compliant with OpenStack
version discovery.
Restructures the API reference to provide more information about the
versioning.

Depends-On: https://review.opendev.org/c/openstack/designate-tempest-plugin/+/848323
Change-Id: I13162711b521472ec8b796ced34d0b7107aaed36
2022-06-30 18:30:54 +00:00
Michael Johnson
631b18bd12 Fix API reference for service statuses
This patch updates the "list service statuses" section of the API
reference to document the response parameters.
It also adds the missing "show service status" section.

Change-Id: If451fc099d2a3dc8ce77c807d9553da7c4122190
2021-12-21 23:46:17 +00:00
Graham Hayes
3d35557851
Add zone 'attributes' to api-ref
Change-Id: Ieb99d4944165e4db32bba3b6b6be627d5d3f4038
2017-12-04 18:47:08 +00:00
melissaml
20237812ec Fix a typo in parameters.yaml
TrivialFix

Change-Id: I461fca511003992927375b9c9064d9bf46c3486e
2016-11-17 12:46:24 +08:00
Maurice Schreiber
e183541373 [api-ref] add optional zone create parameter 'masters'
Change-Id: Ia39b65065b3df2e3d27171165bfe8bb55dee109d
Closes-Bug: #1639271
2016-11-04 16:03:00 +01:00
sonu.kumar
ac6e95b6ae Added docs for Floatingip ptr records to api ref
Change-Id: Ic42871b8ecc9caa4e39ce934e2e297aaf3b5222a
2016-07-12 22:01:15 +05:30
Graham Hayes
619b4753cd Add v2/quotas
This adds the quotas api from /admin to /v2 with some changes.

All users can GET /v2/quotas/<project_id>

Users with "All-Projects" permission can view other projects
(by setting X-Auth-All-Projects:True in the HTTP Headers)

Users with "All-Projects" and "set-quotas" can set other
projects quotas

Moved the API rendering to Designate Object based rendering

Change-Id: I7a0b828824ad6f274d922748f5f9a68157cd939a
Depends-On: I06180a7402fc45940d4b312666cf2dfd33af1305
2016-07-06 20:06:17 +01:00
sonu.kumar
6bcc95d106 Add docs for zone ownership transfer_accept API
Change-Id: Ic544254cecc4d872361f90d471200ba74602488b
depends-on: I3dc042f666be43649bb3dec6e92cc67d1c32578f
2016-06-13 09:21:01 +05:30
Jenkins
a686e6a4c5 Merge "Fix typo in Docs" 2016-06-07 13:10:20 +00:00
sonu.kumar
3167edfc43 Add Blacklist to api-ref docs
Change-Id: Ic74ac379f4a03bceba0e1dd42ffbf91b372f2eef
2016-06-07 13:31:13 +05:30
sonu.kumar
9d3e098cf2 Fix typo in Docs
Change-Id: I67ce36271bbf1985b8e85db17ef5905b7bdde33c
2016-06-06 09:33:56 +05:30
Jenkins
83d2b1cc98 Merge "Fix Optional Tag for X-OpenStack-Request-ID" 2016-06-02 16:17:59 +00:00
Graham Hayes
dd105f4953 Fix parameters.yaml order
Also enabled "-W" flag to sphinx to ensure the file
stays in order going forward

Change-Id: I3817fc329096bbf10bdf69b2bbe4208ba1c142d1
2016-05-30 10:59:18 +02:00
sonu.kumar
bc74ee87b6 Fix typo
Change-Id: I2e1c2a2f7ad8109e708d0696ee3eb010b0ada07d
2016-05-20 13:13:51 +09:00
Graham Hayes
d34406f0a0 Fix Optional Tag for X-OpenStack-Request-ID
Change-Id: If6750d71c5317f8813bd21cffb9a02386502b709
2016-05-19 14:41:22 +01:00
sonu.kumar
c33ebfc833 Add Tsigkey to api-ref docs
Change-Id: I2e951c8a2ef502bd6cc194e3c95992421f6e8208
2016-05-19 08:57:39 +00:00
sonu.kumar
49effdd966 Add Tld to api-ref docs
Change-Id: Id0ca82527fd1cbc1bde28606aeac1dace4a2147d
2016-05-18 12:30:15 +00:00
Graham Hayes
773528d7ca Add Pools to API-Ref Docs
Change-Id: Idc2340d5710be4686916c709354d8dc7e1725d73
2016-05-16 18:41:19 +01:00
Graham Hayes
21569891c7 Add Limits to API-Ref Docs
Change-Id: Id327bfbf93e78064806a8efff8c1e20aac8cc2ba
2016-05-16 18:26:21 +01:00
Graham Hayes
c41555d8ee Add Zone Transfer Request + Accept API-Ref docs
Change-Id: Ibd10ded10b8e304f3548c2f3cc60ab5c64b600b8
2016-05-16 17:58:11 +01:00
Graham Hayes
403b6aec7a Add Zone Tasks, Export and Import API Docs
Adds api-ref docs for:

* Zone Import
* Zone Export
* Zone Tasks
* - XFR
* - Abandon

Change-Id: Id0bfca25969a8def0b5be4969be3ae6e772b0249
2016-05-16 17:36:03 +01:00
Graham Hayes
83d4d031a8 Add Recordset to api-ref docs
Change-Id: I727ef393cf5a730b701f7212c59842d5262172ad
2016-05-16 17:35:56 +01:00
Graham Hayes
e9db59d3b3 Start Designate API-Ref style documentation
Creates api-ref test env
Add basic v2/zones API documentation

Change-Id: I1783234c59319fdcb13b0df90f662253e822bab3
Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5
2016-05-16 16:41:02 +01:00