Skip to content

Improve descriptions in OpenAPI Spec file#10539

Merged
kaxil merged 2 commits intoapache:masterfrom
astronomer:openapi-fixes
Aug 25, 2020
Merged

Improve descriptions in OpenAPI Spec file#10539
kaxil merged 2 commits intoapache:masterfrom
astronomer:openapi-fixes

Conversation

@kaxil
Copy link
Member

@kaxil kaxil commented Aug 24, 2020


^ 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.

@kaxil kaxil requested a review from mik-laj August 24, 2020 23:32
@boring-cyborg boring-cyborg bot added the area:API Airflow's REST/HTTP API label Aug 24, 2020
@kaxil kaxil changed the title Improve descriptions in OpenAPI Spec file (#10417) Improve descriptions in OpenAPI Spec file Aug 24, 2020
- Fix various typo for "collection"
- Some grammar
/version:
get:
summary: Get a version information
summary: Get Airflow version information
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: Get Airflow version information
summary: Get Airflow version

Ideally, this field should be less than 20 characters long.

Screenshot 2020-08-25 at 01 36 00

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@kaxil kaxil merged commit 49cce8b into apache:master Aug 25, 2020
@kaxil kaxil deleted the openapi-fixes branch August 25, 2020 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:API Airflow's REST/HTTP API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants