Skip to content

Commit

Permalink
do it in just one spot
Browse files Browse the repository at this point in the history
Signed-off-by: Doug Davis <dug@us.ibm.com>
  • Loading branch information
Doug Davis committed Mar 12, 2018
1 parent 243462a commit d8705bc
Showing 1 changed file with 11 additions and 40 deletions.
51 changes: 11 additions & 40 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,17 @@ Service Broker MAY reject the request with `412 Precondition Failed` and
provide a message that informs the operator of the API version that is to be
used instead.

## Extending Resources

Senders of messages defined by this specification MAY include additional
fields within the JSON objects. When adding new fields, unique prefixes
SHOULD be used for the field names to reduce the chances of conflicts
with future specification defined fields.

Receivers of a messages defined by this specification that contain unknown
extension fields MUST ignore those fields and MUST NOT halt processing
of those messages due to those fields.

## Platform to Service Broker Authentication

While the communication between a Platform and Service Broker MAY be unsecure,
Expand Down Expand Up @@ -737,10 +748,6 @@ For success responses, the following fields are defined:

\* Fields with an asterisk are REQUIRED.

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

```
{
"state": "in progress",
Expand Down Expand Up @@ -807,10 +814,6 @@ The following HTTP Headers are defined for this operation:

\* Fields with an asterisk are REQUIRED.

Platforms MAY include additional fields within the response. When adding
new fields, Platforms SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

```
{
"service_id": "service-id-here",
Expand Down Expand Up @@ -879,10 +882,6 @@ For success responses, the following fields are defined:
}
```

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

## Updating a Service Instance

By implementing this endpoint, Service Broker authors can enable users to
Expand Down Expand Up @@ -943,10 +942,6 @@ The following HTTP Headers are defined for this operation:

\* Fields with an asterisk are REQUIRED.

Platforms MAY include additional fields within the response. When adding
new fields, Platforms SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

##### Previous Values Object

| Request Field | Type | Description |
Expand Down Expand Up @@ -1043,10 +1038,6 @@ For success responses, the following fields are defined:
}
```

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.


## Binding

Expand Down Expand Up @@ -1155,10 +1146,6 @@ The following HTTP Headers are defined for this operation:

\* Fields with an asterisk are REQUIRED.

Platforms MAY include additional fields within the response. When adding
new fields, Platforms SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

##### Bind Resource Object

The `bind_resource` object contains Platform specific information related to
Expand Down Expand Up @@ -1258,10 +1245,6 @@ For success responses, the following fields are defined:

\* Fields with an asterisk are REQUIRED.

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

##### Device Object

Currently only shared devices are supported; a distributed file system which
Expand All @@ -1274,10 +1257,6 @@ can be mounted on all app instances simultaneously.

\* Fields with an asterisk are REQUIRED.

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

```
{
"credentials": {
Expand Down Expand Up @@ -1374,10 +1353,6 @@ Platform MUST continue to remember the Service Binding.

For a success response, the expected response body is `{}`.

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

## Deprovisioning

When a Service Broker receives a deprovision request from a Platform, it MUST
Expand Down Expand Up @@ -1449,10 +1424,6 @@ For success responses, the following fields are defined:
| --- | --- | --- |
| operation | string | For asynchronous responses, Service Brokers MAY return an identifier representing the operation. The value of this field MUST be provided by the Platform with requests to the [Last Operation](#polling-last-operation) endpoint in a percent-encoded query parameter. If present, MUST be a non-empty string. |

Service Brokers MAY include additional fields within the response. When adding
new fields, Service Brokers SHOULD use a unique prefix for the field names to
reduce the chances of conflict with future specification defined fields.

```
{
"operation": "task_10"
Expand Down

0 comments on commit d8705bc

Please sign in to comment.