Skip to content

Rename assets list-by-alias to list-aliases in airflowctl #68522

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

Open
justinpakzad wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Rename assets list-by-alias to list-aliases in airflowctl #68522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airflow-ctl/docs/images/command_hashes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
main:27a22c00dcf32e7a1a4f06672dc8e3c8
assets:70619a2d92bda80930cde2aefcd8e1cd
assets:6419e20452692f577c4c6f570b74be0c
auth:d79e9c7d00c432bdbcbc2a86e2e32053
backfill:74c8737b0a62a86ed3605fa9e6165874
config:a3d936cb15fe3b547bf6c82cf93d923f
Expand Down
128 changes: 64 additions & 64 deletions airflow-ctl/docs/images/output_assets.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions airflow-ctl/src/airflowctl/api/operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,8 +269,8 @@ def list(self) -> AssetCollectionResponse | ServerResponseError:
"""List all assets from the API server."""
return super().execute_list(path="assets", data_model=AssetCollectionResponse)

def list_by_alias(self) -> AssetAliasCollectionResponse | ServerResponseError:
"""List all assets by alias from the API server."""
def list_aliases(self) -> AssetAliasCollectionResponse | ServerResponseError:
"""List all assets aliases from the API server."""
return super().execute_list(path="/assets/aliases", data_model=AssetAliasCollectionResponse)

def create_event(
Expand Down
2 changes: 1 addition & 1 deletion airflow-ctl/src/airflowctl/ctl/help_texts.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ assets:
get: "Retrieve an asset by its ID"
get-by-alias: "Retrieve an asset by its alias"
list: "List all assets"
list-by-alias: "List all asset aliases"
list-aliases: "List all asset aliases"
create-event: "Create an event for a given asset"
materialize: "Trigger materialization of an asset by its ID"
get-queued-events: "List queued events for a given asset"
Expand Down
4 changes: 2 additions & 2 deletions airflow-ctl/tests/airflow_ctl/api/test_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ def handle_request(request: httpx.Request) -> httpx.Response:
response = client.assets.list()
assert response == assets_collection_response

def test_list_by_alias(self):
def test_list_aliases(self):
assets_collection_response = AssetAliasCollectionResponse(
asset_aliases=[self.asset_alias_response],
total_entries=1,
Expand All @@ -379,7 +379,7 @@ def handle_request(request: httpx.Request) -> httpx.Response:
return httpx.Response(200, json=json.loads(assets_collection_response.model_dump_json()))

client = make_api_client(transport=httpx.MockTransport(handle_request))
response = client.assets.list_by_alias()
response = client.assets.list_aliases()
assert response == assets_collection_response

def test_create_event(self):
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/prek/check_airflowctl_command_coverage.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"assets get-dag-queued-event",
"assets get-dag-queued-events",
"assets get-queued-events",
"assets list-by-alias",
"assets list-aliases",
"assets materialize",
"backfill cancel",
"backfill create",
Expand Down
Loading