Jump to: navigation, search

Difference between revisions of "Trove/update-instance-name"

(Augment existing API call: Update Database Instance)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
This blueprint will augment the existing API PUT/instances/{instanceId} call for renaming an instance name.
+
This blueprint adds PATCH /instances/{instanceId} call for renaming an instance name/attaching or detaching a configuration to an instance.
 +
The long term plan is to deprecate the PUT /instances/{instanceId} call.
 +
 
 +
Blueprint: https://blueprints.launchpad.net/trove/+spec/update-instance-name
  
Blueprint:
 
 
== Justification/Benefits ==
 
== Justification/Benefits ==
Need to provide users capability to rename an instance name after creation.
+
Need to provide users ability to rename a database instance name post creation.
  
 
== Impacts ==
 
== Impacts ==
Line 16: Line 18:
 
=== ReST API ===
 
=== ReST API ===
 
=== Augment existing API call: Update Database Instance ===  
 
=== Augment existing API call: Update Database Instance ===  
 +
The PATCH call does following functions:
 +
(1) updates configuration by doing the necessary checks (same as PUT call)
 +
 +
(2) updates instance name if provided
  
 
'''Request'''
 
'''Request'''
  
PUT/instances/{instanceId}
+
PATCH {tenantId}/instances/{instanceId}
 
<pre>
 
<pre>
 
{
 
{
Line 31: Line 37:
  
 
This call will not return a response body.
 
This call will not return a response body.
 
  
 
== Comments/Questions From Community ==
 
== Comments/Questions From Community ==

Latest revision as of 18:26, 11 September 2014

Description

This blueprint adds PATCH /instances/{instanceId} call for renaming an instance name/attaching or detaching a configuration to an instance. The long term plan is to deprecate the PUT /instances/{instanceId} call.

Blueprint: https://blueprints.launchpad.net/trove/+spec/update-instance-name

Justification/Benefits

Need to provide users ability to rename a database instance name post creation.

Impacts

Configuration

None

Database

No impact

ReST API

Augment existing API call: Update Database Instance

The PATCH call does following functions: (1) updates configuration by doing the necessary checks (same as PUT call)

(2) updates instance name if provided

Request

PATCH {tenantId}/instances/{instanceId}

{
"instance": {
"configuration" : "StagingConfig",
"name" : "Test_Instance"
}
}

Response

This call will not return a response body.

Comments/Questions From Community