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

Jump to bottom

Update documentation to enable test connection #34905

Merged
merged 11 commits into from
Oct 16, 2023
Merged

Update documentation to enable test connection #34905

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f54d292
updating docs for test connection
vatsrahul1001 Oct 13, 2023
b43d775
updating correct file
vatsrahul1001 Oct 13, 2023
309dde9
mend
vatsrahul1001 Oct 13, 2023
099b8a7
removing change from api-generated.ts
vatsrahul1001 Oct 13, 2023
9471dcd
Update airflow/api_connexion/openapi/v1.yaml
vatsrahul1001 Oct 16, 2023
f54f376
updating docs with disclaimer
vatsrahul1001 Oct 16, 2023
89b1d62
updated formatting
vatsrahul1001 Oct 16, 2023
4065b6e
fixing typo
vatsrahul1001 Oct 16, 2023
f1c30b4
Syntax and grammar fixes
uranusjr Oct 16, 2023
7779cdb
fix static check failures
vatsrahul1001 Oct 16, 2023
ae82902
Merge branch 'docs-update-test-connection' of github.com:astronomer/a…
vatsrahul1001 Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions airflow/api_connexion/openapi/v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,8 @@ paths:
summary: Test a connection
description: |
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
vatsrahul1001 marked this conversation as resolved.
Show resolved Hide resolved
It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
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
description: |
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
description: >
Test a connection.
Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
It can also be controlled by the environment variable `AIRFLOW__CORE__TEST_CONNECTION`.

This fixes the rendering issues in the generated ts comment. (Don’t apply this on GitHub, you need to do this locally to go through pre-commit)


*New in version 2.2.0*
x-openapi-router-controller: airflow.api_connexion.endpoints.connection_endpoint
Expand Down
5 changes: 3 additions & 2 deletions airflow/www/static/js/types/api-generated.ts
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

This file is generated from openapi/v1.yaml and you should not modify it correctly. Modify the specification file instead and use pre-commit to sync the files instead. See the contribution guide located in the repository root to learn how to set up the dev toolchain.

Original file line number Diff line number Diff line change
Expand Up @@ -2567,8 +2567,9 @@ export interface operations {
};
/**
* Test a connection.
* Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
* It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
* Testing Connections is disabled by default set test_connection flag to enabled in Airflow configuration (airflow.cfg).
* It can also be controlled by the environment variable AIRFLOW__CORE__TEST_CONNECTION.
*
* *New in version 2.2.0*
*/
test_connection: {
Expand Down