Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add X-Api-Info-Location header to the profile document #686

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+37 −0
Open

Add X-Api-Info-Location header to the profile document #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions profile.md
View file
Open in desktop
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
View file
Open in desktop
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