Difference between revisions of "Designate/Blueprints/Recordset Record API Redesign"

Revision as of 19:11, 29 April 2014

Contents

   1 Overview

Overview

Gerrit Patch	[]
Launchpad Blueprint	[1]

This blueprint proposes to eliminate the Records resource and on keep the RecordSets resource.

The API for recordsets and records is too complicated. Currently, a user is forced to create a recordset before creating a record. This leads to a confusing user experience.Users will create, update and delete recordsets. When the user creates a recordset the code will determine if it should be a new recordset or a record under an existing recordset.

API Resource

Current API

/zones/zone{id}/recordsets/recordset{id}/records/record{id}

New API

/zones/zone{id}/recordsets/recordset{id}

API Details: Create / List / Patch / Put / Delete Recordset

Verb	Resource	Description
GET	/zones/zone{id}/recordsets	Returns all the recordsets for a zone
GET	/zones/zone{id}/recordsets/{id}	Returns a specific recordset for a zone
POST	/zones/zone{id}/recordsets	Creates a new recordset or adds a new record to a recordset
PUT	/blacklist/{id}	Returns the specific blacklisted domain that was updated
DELETE	/blacklist/{id}	Delete the blacklisted domain. No message body is expected in the request

@@ Line 28: / Line 28: @@
 === API Details: Create / List / Patch / Put / Delete Recordset ===
+{| class="wikitable"
+|-
+! Verb !! Resource !! Description
+|-
+| GET || /zones/zone{id}/recordsets || Returns all the recordsets for a zone
+|-
+| GET || /zones/zone{id}/recordsets/{id} || Returns a specific recordset for a zone
+|-
+| POST || /zones/zone{id}/recordsets|| Creates a new recordset or adds a new record to a recordset
+|-
+| PUT || /blacklist/{id} || Returns the specific blacklisted domain that was updated
+|-
+| DELETE || /blacklist/{id} || Delete the blacklisted domain. No message body is expected in the request
+|}