Skip to content

Commit

Permalink
add x-api-info-location header to profile
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt McNeeney committed Jul 2, 2019
1 parent e7dc9b4 commit b9785b5
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
34 changes: 34 additions & 0 deletions profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ or REQUIRED level requirements defined herein.
- [Notations and Terminology](#notations-and-terminology)
- [Notational Conventions](#notational-conventions)
- [Terminology](#terminology)
- [Additional Headers](#additional-headers)
- [Cloud Foundry Info Location Header](#cloud-foundry-info-location-header)
- [Originating Identity Header](#originating-identity-header)
- [Cloud Foundry Originating Identity Header](#cloud-foundry-originating-identity-header)
- [Kubernetes Originating Identity Header](#kubernetes-originating-identity-header)
Expand Down Expand Up @@ -42,6 +44,38 @@ be interpreted as described in [RFC 2119]( https://tools.ietf.org/html/rfc2119).
Please refer to terminology defined by the
[Open Service Broker API specification](spec.md#terminology).


## Additional Headers

### Cloud Foundry Info Location Header

The `X-API-Info-Location` header is used to provide Service Brokers with an
endpoint that can be used to fetch information about the specific Cloud Foundry
deployment from which the request originated.

The header consists of a `value` string, where the `value` is a Base64 encoded
serialized JSON object.

The following properties MUST appear within the JSON encoded `value`:

| Property | Type | Description |
| --- | --- | --- |
| 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. |

Platforms MAY include additional properties.

For example, a `value` of:
```json
{
"info_location_url": "https://api.platform.example.com/v2/info"
}
```
would appear in the HTTP Header as:
```
X-API-Info-Location: ewogICJpbmZvX2xvY2F0aW9uX3VybCI6ICJodHRwczovL2FwaS5wbGF0Zm9ybS5leGFtcGxlLmNvbS92Mi9pbmZvIgp9
```


## Originating Identity Header

In the [Open Service Broker API specification](spec.md) it defines an
Expand Down
3 changes: 3 additions & 0 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ The following HTTP Headers are defined for the operations detailed in this spec:

\* Headers with an asterisk are REQUIRED.

Additional headers for specific Platforms are detailed in the
[profile](profile.md#additional-headers) document.

### API Version Header

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

0 comments on commit b9785b5

Please sign in to comment.