diff options
| author | Jenkins <jenkins@review.openstack.org> | 2013-08-21 16:21:13 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2013-08-21 16:21:13 +0000 |
| commit | d685d2c6e53714403d3ce72aecf4795dcd7c710b (patch) | |
| tree | b2eaec8cc8c39e08b1a67be9f5f65a8f676f0f0b | |
| parent | 16e75ae52570f26ec038ccc135e447f4b6374cde (diff) | |
| parent | e4e46d3f94ecf25f027136933ba522d8f0a72fc3 (diff) | |
| download | designate-d685d2c6e53714403d3ce72aecf4795dcd7c710b.tar.gz | |
Merge "docs: Add 'description' field to domains"
| -rw-r--r-- | designate/resources/schemas/v1/domain.json | 4 | ||||
| -rw-r--r-- | doc/source/rest/domains.rst | 31 |
2 files changed, 21 insertions, 14 deletions
diff --git a/designate/resources/schemas/v1/domain.json b/designate/resources/schemas/v1/domain.json index a1b22920..520c2962 100644 --- a/designate/resources/schemas/v1/domain.json +++ b/designate/resources/schemas/v1/domain.json @@ -49,13 +49,13 @@ }, "created_at": { "type": "string", - "description": "Date and time of image registration", + "description": "Date and time of domain creation", "format": "date-time", "readonly": true }, "updated_at": { "type": ["string", "null"], - "description": "Date and time of image registration", + "description": "Date and time of last domain update", "format": "date-time", "readonly": true } diff --git a/doc/source/rest/domains.rst b/doc/source/rest/domains.rst index b324657f..2b1625ea 100644 --- a/doc/source/rest/domains.rst +++ b/doc/source/rest/domains.rst @@ -41,18 +41,21 @@ Create Domain "name": "domain1.com.", "ttl": 3600, "serial": 1351800588, - "email": "nsadmin@example.org" - "created_at": "2012-11-01T20:09:48.094457" + "email": "nsadmin@example.org", + "created_at": "2012-11-01T20:09:48.094457", + "updated_at": null, + "description": null } :form created_at: timestamp + :form updated_at: timestamp :form name: domain name - :param id: Domain ID - :type id: uuid + :form id: uuid :form ttl: time-to-live numeric value in seconds :form serial: numeric seconds :form email: email address + :form description: UTF-8 text field :statuscode 200: Success :statuscode 401: Access Denied :statuscode 400: Invalid Object @@ -87,16 +90,19 @@ Get a Domain "ttl": 3600, "serial": 1351800668, "email": "nsadmin@example.org", - "created_at": "2012-11-01T20:11:08.000000" + "created_at": "2012-11-01T20:11:08.000000", + "updated_at": null, + "description": null } :form created_at: timestamp + :form updated_at: timestamp :form name: domain name - :param id: Domain ID - :type id: uuid + :form id: uuid :form ttl: time-to-live numeric value in seconds :form serial: numeric seconds :form email: email address + :form description: UTF-8 text field :statuscode 200: Success :statuscode 401: Access Denied @@ -139,17 +145,18 @@ Update a Domain "ttl": 7200, "serial": 1351818367, "created_at": "2012-11-02T00:58:42.000000", - "updated_at": "2012-11-02T01:06:07.000000" + "updated_at": "2012-11-02T01:06:07.000000", + "description": null } - :form name: domain name :form created_at: timestamp :form updated_at: timestamp - :param id: Domain ID - :type id: uuid - :form email: email address + :form name: domain name + :form id: uuid :form ttl: time-to-live numeric value in seconds :form serial: numeric seconds + :form email: email address + :form description: UTF-8 text field :statuscode 200: Success :statuscode 401: Access Denied :statuscode 400: Invalid Object |