This repository has been archived by the owner on Jul 16, 2020. It is now read-only.
Read-only API keys, stricter schema typing, and more examples #35
Conversation
This file contains 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
ehlertjd
approved these changes
Aug 27, 2018
| It is possible to interact with the Flywheel data hierarchy using our [python](https://flywheel-io.github.io/core/branches/master/python/getting_started.html), [matlab](https://flywheel-io.github.io/core/branches/master/matlab/getting_started.html), and (slated for an overhaul) [golang](https://github.com/flywheel-io/sdk) SDKs. | ||
|
|
||
| Generally, you will want to figure out a script that you like, using your normal user API key, before turning it into a gear. To do this, specify an `api-key` type input as show in the example above, and use that value in your gear script. | ||
|
|
There was a problem hiding this comment.
Maybe one-sentence call-out that by default the api-key will have write permissions and can be made read-only.
There was a problem hiding this comment.
It's in the example blob, but I'll add it here too. Good to have in both places
…s; add several examples and doc
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Until now, the schema combined all gear input types. This allowed schema directives to be added to input types that would be ignored (context, api-key).
This PR fixes that while also adding a read-only specifier to the api-key type, provides some more bona-fide validation tests, and adds missing documentation about the api-key input. Notably absent are invalid examples, which we should add at some point.
Is this a semantic or operational change? If so: