openstack/designate
Code Issues Proposed changes

docs: Add 'description' field to domains

Browse Source 
When the 'description' field got added for domains and records,
only the documentation for records was updated.

Also, fix minor domain schema error - the description for the
"created_at" and "updated_at" fields in domain.json is incorrect
in the v1 code base.

Change-Id: Id50ed109be81723da8e46e23f792173f435e0e3e
Fixes: bug#1213273
This commit is contained in:
betsy luzader 2013-08-20 15:49:26 -05:00
parent 93822f87bc
commit e4e46d3f94
2 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
designate/resources/schemas/v1/domain.json
View File

@ -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
}

31
doc/source/rest/domains.rst
View File

@ -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