Skip to content

Commit d1c6038

Browse files
authored
Merge pull request #45 from Peripli/instance_and_binding_parameters
Retrieve instance Parameters of service instances and bindings
2 parents 1c7ab5b + 395405d commit d1c6038

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

api.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@
3030
- [Service Instance Management](#service-instance-management)
3131
- [Provisioning a Service Instance](#provisioning-a-service-instance)
3232
- [Fetching a Service Instance](#fetching-a-service-instance)
33+
- [Fetching a Service Instance Parameters](#fetching-a-service-instance-parameters)
3334
- [Listing Service Instances](#listing-service-instances)
3435
- [Patching a Service Instance](#patching-a-service-instance)
3536
- [Deleting a Service Instance](#deleting-a-service-instance)
3637
- [Service Binding Management](#service-binding-management)
3738
- [Creating a Service Binding](#creating-a-service-binding)
3839
- [Fetching a Service Binding](#fetching-a-service-binding)
40+
- [Fetching a Service Binding Parameters](#fetching-a-service-binding-parameters)
3941
- [Listing Service Bindings](#listing-service-bindings)
4042
- [Patching a Service Binding](#patching-a-service-binding)
4143
- [Deleting a Service Binding](#deleting-a-service-binding)
@@ -979,6 +981,37 @@ The Service Manager MAY choose to provide cached data and not to [fetch the data
979981
| usable | boolean | If the instance is `usable` or not (as per the OSB spec `instance_usable`) |
980982
| ready | boolean | Whether the resource is ready or not. |
981983

984+
### Fetching a Service Instance Parameters
985+
986+
Service Manager fetches the data from the upstream broker.
987+
988+
#### Route
989+
990+
`GET /v1/service_instances/:service_instance_id/parameters`
991+
992+
`:service_instance_id` MUST be the ID of a previously provisioned service instance.
993+
The instances_retrievable feature must be enabled for the service offering in broker catalog.
994+
995+
#### Response Body
996+
997+
##### Service Instance Parameters Object
998+
999+
```json
1000+
{
1001+
"param1":"value1",
1002+
"param2":"value2"
1003+
}
1004+
```
1005+
1006+
#### Response
1007+
1008+
| Status Code | Description |
1009+
| ----------- | ----------- |
1010+
| 200 OK | MUST be returned if the request execution was successful. |
1011+
| 404 Not Found | MUST be returned if the requested resource is missing, the creation operation is still in progress, or if the user is not authorized to access this resource. |
1012+
| 400 Bad Request | MUST be returned if the broker doesn't support fetching of instances for this service offering or if request was sent with the value true for query param: async. (if the operation is asynchronous) |
1013+
| 502 Bad Gateway | MUST be returned if there was a failure to parse the parameters of the service instance returned from a broker. |
1014+
9821015
### Listing Service Instances
9831016

9841017
Listing `service instances` MUST comply with [listing all resource entities of a resource type](#listing-all-resource-entities-of-a-resource-type).
@@ -1132,6 +1165,36 @@ The Service Manager MAY choose to provide cached data and not to [fetch the data
11321165
| updated_at | string | The time of the last update [in ISO 8601 format](#data-formats). |
11331166
| ready | boolean | Whether the resource is ready or not. |
11341167

1168+
### Fetching a Service Binding Parameters
1169+
1170+
Service Manager fetches the data from the upstream broker.
1171+
1172+
#### Route
1173+
1174+
`GET /v1/service_bindings/:service_binding_id/parameters`
1175+
1176+
`:service_binding_id` MUST be the ID of a previously created service binding.
1177+
The bindings_retrievable feature must be enabled for the service offering in broker catalog.
1178+
1179+
#### Response Body
1180+
1181+
##### Service Binding Object
1182+
1183+
```json
1184+
{
1185+
"param1":"value1",
1186+
"param2":"value2"
1187+
}
1188+
```
1189+
#### Response
1190+
1191+
| Status Code | Description |
1192+
| ----------- | ----------- |
1193+
| 200 OK | MUST be returned if the request execution was successful. |
1194+
| 404 Not Found | MUST be returned if the requested resource is missing, if the creation operation is still in progress, or if the user is not authorized to access this resource. |
1195+
| 400 Bad Request | MUST be returned if the broker doesn't support fetching of bindings for this service offering or if request was sent with the value true for the query param: async. (if the operation is asynchronous). |
1196+
| 502 Bad Gateway | MUST be returned if there was a failure to parse the parameters of the service binding returned from a broker. |
1197+
11351198
### Listing Service Bindings
11361199

11371200
Listing `service bindings` MUST comply with [listing all resource entities of a resource type](#listing-all-resource-entities-of-a-resource-type).

0 commit comments

Comments
 (0)