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

Add security related topics to spec #145

Merged
merged 1 commit into from
Dec 8, 2020
Merged

Add security related topics to spec #145

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
20 changes: 19 additions & 1 deletion openapi/task_execution_service.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,25 @@ info:

The TES API specification is written in OpenAPI and embodies a RESTful service
philosophy. It uses JSON in requests and responses and standard
HTTP/HTTPS for information transport.
HTTP/HTTPS for information transport. HTTPS should be used rather than plain HTTP
except for testing or internal-only purposes.

### Authentication and Authorization

Is is envisaged that most TES API instances will require users to authenticate to use the endpoints.
However, the decision if authentication is required should be taken by TES API implementers.


If authentication is required, we recommend that TES implementations use an OAuth2 bearer token, although they can choose other mechanisms if appropriate.


Checking that a user is authorized to submit TES requests is a responsibility of TES implementations.

### CORS

If TES API implementation is to be used by another website or domain it must implement Cross Origin Resource Sharing (CORS).
Please refer to https://w3id.org/ga4gh/product-approval-support/cors for more information about GA4GH’s recommendations and how to implement CORS.


servers:
- url: /ga4gh/tes/v1
Expand Down