-
Notifications
You must be signed in to change notification settings - Fork 53
Add CORS recommendation #131
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -81,6 +81,9 @@ Sub-modules aren't checked out by default, so to get the directory populated | |
| either use `git submodule update --init --recursive` if you've already cloned it, | ||
| or clone from the start with `git clone --recursive [email protected]:radiantearth/stac-api-spec.git`. | ||
|
|
||
| **Implementation Recommendations:** Recommendations for implementing a STAC API may be found [here](implementation.md). | ||
| These are mostly concerns that apply to an entire API implementation and are not part of the specification itself. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Anyone building software that catalogs imagery or other geospatial assets is welcome to collaborate. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Implementation Recommendations | ||
|
|
||
| This document describes implementation recommendations for a STAC API. | ||
|
|
||
| ## CORS | ||
|
|
||
| It is recommended that public APIs advertise a permissive CORS configuration so UIs running on a different domain | ||
| may more easily access them. | ||
|
|
||
| APIs should acknowledge pre-flight request headers. In general, these header values should be set on responses: | ||
|
|
||
| ``` | ||
| access-control-allow-origin: * | ||
| access-control-allow-methods: OPTIONS, POST, GET | ||
| access-control-allow-headers: Content-Type | ||
philvarner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| access-control-allow-credentials: false | ||
philvarner marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| It is relatively safe to use these headers for all endpoints. However, one may want to restrict the methods to only those that apply to each endpoint. For example, the `/collection/{collectionId}/items` endpoint should only allow OPTIONS and GET, since POST is only used by the Transactions Extension, which presumably would require authentication as it is mutating data. | ||
|
|
||
| Implementations that support the Transactions Extension or require credentials for some operations will need to | ||
| implement different behavior, for example, allowing credentials when requests are coming from a trusted domain or also allowing DELETE, PUT, or PATCH methods. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.