Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 9dadb73

Browse files
author
Derik Evangelista
committed
**docs**: remove status field from SB object
[#172646313](https://www.pivotaltracker.com/story/show/172646313)
1 parent 078281a commit 9dadb73

2 files changed

Lines changed: 5 additions & 8 deletions

File tree

docs/v3/source/includes/api_resources/_service_brokers.erb

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
44
"name": "my_service_broker",
55
"url": "https://example.service-broker.com",
6-
"status": "available",
76
"created_at": "2015-11-13T17:02:56Z",
87
"updated_at": "2016-06-08T16:41:26Z",
98
"relationships": {
@@ -54,7 +53,6 @@
5453
"guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
5554
"name": "my_service_broker",
5655
"url": "https://example.service-broker.com",
57-
"status": "available",
5856
"created_at": "2015-11-13T17:02:56Z",
5957
"updated_at": "2016-06-08T16:41:26Z",
6058
"relationships": {} ,
@@ -75,7 +73,6 @@
7573
"guid": "7aa37bad-6ccb-4ef9-ba48-9ce3a91b2b62",
7674
"name": "another_service_broker",
7775
"url": "https://another-example.service-broker.com",
78-
"status": "available",
7976
"created_at": "2015-11-13T17:02:56Z",
8077
"updated_at": "2016-06-08T16:41:26Z",
8178
"relationships": {
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
### Service Broker Jobs
22

3-
CRUD operations for service brokers are asynchronous. `create`, `update` and `delete` endpoints return urls to `jobs` in the `Location` header of the HTTP response.
3+
CRUD operations for service brokers are asynchronous. `create`, `update` and `delete` endpoints include a job URL in the `Location` header of the HTTP response.
44

5-
These jobs are the only source of information about the progress and end state of the operation. Therefore, the job must be polled to find out when the process ends and if it was successful.
6-
It's also worth noting that there is no mechanism to link a service broker with its jobs, apart from the `Location` header in the API response.
5+
These jobs are the only source of information about the progress of the operation. Therefore, the job must be polled to find out when the process ends and if it was successful.
6+
There is no mechanism to link a service broker with its jobs, apart from the `Location` header in the API response.
77

8-
When a failure occurs during a create job, then the service broker won't be usable. However it will still be included in the `GET` endpoints responses, hence the importance of querying the job to find out the end status.
8+
When a failure occurs during a create job, the service broker won't be usable. It will still be included in the `GET` endpoints responses, hence the importance of querying the job to find out the end status.
99

10-
When updating a service broker, the changes will be rollbacked in the event the job fails. The service broker will remain unchanged with no indication that the update operation failed. Querying the job will provide such information.
10+
When updating a service broker, the changes will be rolled-back in the event of the job failing. The service broker will remain unchanged with no indication that the update operation failed. Querying the job will provide such information.
1111

0 commit comments

Comments
 (0)