This repository has been archived by the owner on Sep 4, 2021. It is now read-only.
Docs api example preface #1435
Merged
Docs api example preface #1435
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
…o gem
FlynnDocs.api_example_preface(name) will return the contents of
docs/api-examples/{name}.md or an empty string if it doesn't exist.
This should be used when rendering the api examples.
Signed-off-by: Jesse Stuart <jesse@jessestuart.ca>
|
|
||
|
|
||
| All requests are authenticated using [basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication) where the user name is blank and the password is your controller key. You may alternatively use the `key` URL parameter with the controller key for event streams (this allows using them via JavaScript in the browser). | ||
|
|
There was a problem hiding this comment.
This should include the flynn -a controller env get CONTROLLER_KEY command (I think that's the name, test it to be sure)
jvatic
force-pushed
the
docs-api-example-preface
branch
from
e24052e
to
af92287
Compare
|
@titanous comment addressed |
| <h1>Controller</h1> | ||
|
|
||
|
|
||
| All requests are authenticated using [basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication) where the user name is blank and the password is your controller key. You may alternatively use the `key` URL parameter with the controller key for event streams (this allows using them via JavaScript in the browser). You can retreive your controller key by running `flynn -a controller env get AUTH_KEY`. |
There was a problem hiding this comment.
s/retreive/retrieve
s/user name/username
jvatic
force-pushed
the
docs-api-example-preface
branch
from
af92287
to
9223a51
Compare
|
|
||
| All requests are authenticated using [basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication) where the username is blank and the password is your controller key. You may alternatively use the `key` URL parameter with the controller key for event streams (this allows using them via JavaScript in the browser). You can retrieve your controller key by running `flynn -a controller env get AUTH_KEY`. | ||
|
|
||
| All paths below are relative to `controller.CLUSTER_DOMAIN`. |
There was a problem hiding this comment.
This line needs to be clearer, something like "The API root URL is the controller domain, by default https://controller.$CLUSTER_DOMAIN."
|
ping |
Signed-off-by: Jesse Stuart <jesse@jessestuart.ca>
jvatic
force-pushed
the
docs-api-example-preface
branch
from
9223a51
to
5ea8ece
Compare
|
updated |
|
LGTM |
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.
No description provided.