Skip to content

Commit b9785b5

Browse files
author
Matt McNeeney
committed
add x-api-info-location header to profile
1 parent e7dc9b4 commit b9785b5

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

profile.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ or REQUIRED level requirements defined herein.
1515
- [Notations and Terminology](#notations-and-terminology)
1616
- [Notational Conventions](#notational-conventions)
1717
- [Terminology](#terminology)
18+
- [Additional Headers](#additional-headers)
19+
- [Cloud Foundry Info Location Header](#cloud-foundry-info-location-header)
1820
- [Originating Identity Header](#originating-identity-header)
1921
- [Cloud Foundry Originating Identity Header](#cloud-foundry-originating-identity-header)
2022
- [Kubernetes Originating Identity Header](#kubernetes-originating-identity-header)
@@ -42,6 +44,38 @@ be interpreted as described in [RFC 2119]( https://tools.ietf.org/html/rfc2119).
4244
Please refer to terminology defined by the
4345
[Open Service Broker API specification](spec.md#terminology).
4446

47+
48+
## Additional Headers
49+
50+
### Cloud Foundry Info Location Header
51+
52+
The `X-API-Info-Location` header is used to provide Service Brokers with an
53+
endpoint that can be used to fetch information about the specific Cloud Foundry
54+
deployment from which the request originated.
55+
56+
The header consists of a `value` string, where the `value` is a Base64 encoded
57+
serialized JSON object.
58+
59+
The following properties MUST appear within the JSON encoded `value`:
60+
61+
| Property | Type | Description |
62+
| --- | --- | --- |
63+
| info_location_url | string | The URL of an endpoint that can be used to fetch information about the Cloud Foundry deployment from which the request originated. |
64+
65+
Platforms MAY include additional properties.
66+
67+
For example, a `value` of:
68+
```json
69+
{
70+
"info_location_url": "https://api.platform.example.com/v2/info"
71+
}
72+
```
73+
would appear in the HTTP Header as:
74+
```
75+
X-API-Info-Location: ewogICJpbmZvX2xvY2F0aW9uX3VybCI6ICJodHRwczovL2FwaS5wbGF0Zm9ybS5leGFtcGxlLmNvbS92Mi9pbmZvIgp9
76+
```
77+
78+
4579
## Originating Identity Header
4680

4781
In the [Open Service Broker API specification](spec.md) it defines an

spec.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,9 @@ The following HTTP Headers are defined for the operations detailed in this spec:
157157

158158
\* Headers with an asterisk are REQUIRED.
159159

160+
Additional headers for specific Platforms are detailed in the
161+
[profile](profile.md#additional-headers) document.
162+
160163
### API Version Header
161164

162165
Requests from the Platform to the Service Broker MUST contain a header that

0 commit comments

Comments
 (0)