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

Commit 0c01b0a

Browse files
author
Derik Evangelista
committed
v3(docs): add missing bits to cred binding docs
[#173129426](https://www.pivotaltracker.com/story/show/173129426)
1 parent 8dc560b commit 0c01b0a

3 files changed

Lines changed: 43 additions & 2 deletions

File tree

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22
{
33
"guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
44
"type": "app",
5+
"name": "some-name",
56
"created_at": "2015-11-13T17:02:56Z",
67
"updated_at": "2016-06-08T16:41:26Z",
8+
"last_operation": {
9+
"type": "create",
10+
"state": "succeeded",
11+
"created_at": "2015-11-13T17:02:56Z",
12+
"updated_at": "2016-06-08T16:41:26Z"
13+
},
714
"relationships": {
815
"app": {
916
"data": {
@@ -34,8 +41,10 @@
3441
{
3542
"guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
3643
"type": "key",
44+
"name": "some-name",
3745
"created_at": "2015-11-13T17:02:56Z",
3846
"updated_at": "2016-06-08T16:41:26Z",
47+
"last_operation": null,
3948
"relationships": {
4049
"service_instance": {
4150
"data": {
@@ -74,14 +83,14 @@
7483
{
7584
"guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
7685
"type": "app",
86+
"name": "some-binding-name",
7787
"created_at": "2015-11-13T17:02:56Z",
7888
"updated_at": "2016-06-08T16:41:26Z",
7989
"last_operation": {
8090
"type": "create",
8191
"state": "succeeded",
8292
"created_at": "2015-11-13T17:02:56Z",
83-
"created_at": "2015-11-13T17:02:56Z",
84-
"updated_at": "2015-11-13T17:02:56Z"
93+
"updated_at": "2016-06-08T16:41:26Z"
8594
},
8695
"relationships": {
8796
"app": {
@@ -110,6 +119,7 @@
110119
{
111120
"guid": "7aa37bad-6ccb-4ef9-ba48-9ce3a91b2b62",
112121
"type": "key",
122+
"name": "some-key-name",
113123
"created_at": "2015-11-13T17:02:56Z",
114124
"updated_at": "2016-06-08T16:41:26Z",
115125
"last_operation": null,
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
### The service broker object
2+
3+
```
4+
Example Service Credential Binding object
5+
```
6+
```json
7+
<%= yield_content :single_service_credential_binding_app %>
8+
```
9+
10+
Name | Type | Description
11+
---- | ---- | -----------
12+
**guid** | _uuid_ | Unique identifier for the service credential binding
13+
**name** | _string_ | Name of the binding. Defaults to the service instance name when not defined.
14+
**type** | _string_ | Either `app` or `key`
15+
**last_operation** (*experimental*)| _[last operation object](#the-last-operation-object-for-service-credential-binding)_ | The last operation of this binding; `null` when type is `key`
16+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the object was created
17+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the object was last updated
18+
**relationships.service_instance** | [_to-one relationship_](#to-one-relationships) | The service instance that this binding is originated from
19+
**relationships.app** | [_to-one relationship_](#to-one-relationships) | The app using this binding; omitted for `key` bindings
20+
**links** | [_links object_](#links) | Links to related resources
21+
22+
#### The last operation object for service credential binding
23+
24+
Name | Type | Description
25+
---- | ---- | -----------
26+
**type** | _string_ | Either `create`, `update`, or `delete`
27+
**state** | _string_ | Either `in progress`, `succeeded`, or `failed`
28+
**description** | _string_ | A textual explanation associated with this state
29+
**created_at** | _[timestamp](#timestamps)_ | The time with zone when the operation started
30+
**updated_at** | _[timestamp](#timestamps)_ | The time with zone when the operation was last updated

docs/v3/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -356,6 +356,7 @@ includes:
356356
- experimental_resources/service_bindings/list
357357
- experimental_resources/service_bindings/delete
358358
- experimental_resources/service_credential_bindings/header
359+
- experimental_resources/service_credential_bindings/object
359360
- experimental_resources/service_credential_bindings/get
360361
- experimental_resources/service_credential_bindings/list
361362
- experimental_resources/service_instances/header

0 commit comments

Comments
 (0)