Add introduction to Stable RESTT API #10548
Merged
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
kaxil
reviewed
Aug 25, 2020
Comment on lines
38
to
42
| The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its | ||
| endpoint's corresponding resource. | ||
| The name of a resource is typically plural, and expressed in camelCase. Example: `jobGroups`. | ||
|
|
||
| Resource names are used as part of endpoint URLs, as well as in API parameters and responses. |
There was a problem hiding this comment.
Suggested change
| The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its | |
| endpoint's corresponding resource. | |
| The name of a resource is typically plural, and expressed in camelCase. Example: `jobGroups`. | |
| Resource names are used as part of endpoint URLs, as well as in API parameters and responses. | |
| The term `resource` refers to a single type of object in the Airflow metadata. An API is broken up by its | |
| endpoint's corresponding resource. | |
| The name of a resource is typically plural and expressed in camelCase. Example: `jobGroups`. | |
| Resource names are used as part of endpoint URLs, as well as in API parameters and responses. |
|
|
||
| Note that you will need to pass an credentials data. | ||
|
|
||
| For e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authroization is used: |
There was a problem hiding this comment.
Suggested change
| For e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authroization is used: | |
| For e.g., here is how to pause a DAG with [curl](https://curl.haxx.se/), when basic authorization is used: |
mik-laj
force-pushed
the
api-introduction
branch
from
f4748f3 to
70f7a89
Compare
|
@kaxil All suggestion accepted. |
kaxil
approved these changes
Aug 25, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Preview: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/PolideaInternal/airflow/api-introduction/airflow/api_connexion/openapi/v1.yaml
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.