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.

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

AIP-84 Migrate public endpoints from api_connexion to the new Rest API #42370

Closed
1 task done
pierrejeambrun opened this issue Sep 20, 2024 · 33 comments
Closed
1 task done
Assignees
Labels
AIP-84 Modern Rest API area:API Airflow's REST/HTTP API kind:meta High-level information important to the community

Comments

@pierrejeambrun
Copy link
Member

pierrejeambrun commented Sep 20, 2024

Body

#42366 is taking care of migrating private endpoints.

This issue focuses on migrating all the public ones. Ideally they shouldn't change too much and be feature rich compare to airflow 2.x.

An exemple PR can be found here #42196

Tasks (total ~ 81 endpoints)

Backfill (6 endpoints) @dstandish

Config (2 endpoints) @rawwar

Connection @bugraoz93 (6 endpoints)

DAG (5 endpoints)

Dag Parsing (1 endpoint)

Dag Runs @rawwar (9 endpoints)

Dag Source (1 endpoint)

Dag Stats (1 endpoint)

Dag Warnings (1 endpoint) @rawwar

Dataset / Assets (10 endpoints) @amoghrajesh

Event Logs (2 endpoints)

Extra Link (1 endpoint)

Monitor (2 endpoints)

Import Error (2 endpoints) @jason810496

Log (1 endpoint)

Plugin (1 endpoint)

Pool (5 endpoints) @pierrejeambrun

Provider (1 endpoint)

Task (2 endpoints) @omkar-foss

Task Instance (15 endpoints) @pierrejeambrun

Variables (5 endpoints)

XCom (2 endpoints)

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.
@pierrejeambrun pierrejeambrun added the kind:meta High-level information important to the community label Sep 20, 2024
@dosubot dosubot bot added the area:API Airflow's REST/HTTP API label Sep 20, 2024
@pierrejeambrun pierrejeambrun added the AIP-84 Modern Rest API label Sep 20, 2024
@omkar-foss
Copy link
Collaborator

Trimming down views.py is very tempting 😄

May I pick this up? If yes, please assign this issue to me. Thanks!

@pierrejeambrun
Copy link
Member Author

pierrejeambrun commented Sep 23, 2024

Hello @omkar-foss,

views.py are mostly 'rendered' front end that will get replaced by the new UI react, in views.py you also find private/UI REST route, most of them are with the /object/ prefix, such as def grid_data. If you want to work on those UI dedicated endpoints you can that would be part of #42366.

This issue focuses on the public endpoints, those are located under the api_connexion folder.

In anycase, just mention the endpoint you are working on, so people do not do the same ones, and I will update the description to track that :). I think we should do one at the time.

@omkar-foss
Copy link
Collaborator

Hi @pierrejeambrun, thank you for explaining it to me, much appreciate it.

I'll start migrating the public endpoints, beginning with migration of the DAG Details API (get_dag_details) in api_connexion/endpoints/dag_endpoint.py.

Since this is a meta issue (missed that previously!), I'll create the issue/PR corresponding to the endpoint(s) that I'll be working on and link to this issue (like usual).

P.S: views.py will have to wait :)

@bugraoz93
Copy link
Collaborator

Thanks for creating the ticket @pierrejeambrun! Let me take connection endpoints

@pierrejeambrun
Copy link
Member Author

Great, thanks @bugraoz93

@bugraoz93
Copy link
Collaborator

bugraoz93 commented Sep 30, 2024

Thanks for assigning! Let me save you from regular updates :) I created issues for all the endpoints in connections.

@pierrejeambrun
Copy link
Member Author

pierrejeambrun commented Oct 1, 2024

Great, thanks @bugraoz93. I just updated the meta issue with those new additions. Let me know if you plan to work on all of them so I can assign you, or just some of them so I can label the others with good first issue and let other contributors grab them :)

@bugraoz93
Copy link
Collaborator

I am planning to work on all of them @pierrejeambrun. if you can assign them to me, that would be great! Thanks :)

@omkar-foss
Copy link
Collaborator

Hey folks! After #42631 (open for review), I can pick up these two next in order:

  1. get_dag - AIP-84 Migrate the public endpoint Get DAG to FastAPI #42652
  2. delete_dag - AIP-84 Migrate the public endpoint Delete DAG to FastAPI #42650

With these 2 done, I suppose we should have the dags.py migration complete. When you find some time, please update this meta and assign these to me, thank you! 😃

@bbovenzi
Copy link
Contributor

bbovenzi commented Oct 2, 2024

@omkar-foss Assigned. Thanks for picking these issues up!

@bbovenzi
Copy link
Contributor

@prabhusneha I see you're assigned to Logs. What is the status of getting the logs for a task instance? That would be a useful one to get in the UI soon!

@utkarsharma2
Copy link
Contributor

@prabhusneha I see you're assigned to Logs. What is the status of getting the logs for a task instance? That would be a useful one to get in the UI soon!

Hey, @bbovenzi I'm taking care of task instance logs endpoint, I'm mostly done with it, but there are a couple of test cases that require setting users in fastapi which requires a little more work. I'll keep you posted.

@phanikumv
Copy link
Contributor

Thanks @utkarsharma2 (updated the description accordingly).

@pierrejeambrun
Copy link
Member Author

Thanks a lot to everyone that contributed, closing a big one 🎉

@github-project-automation github-project-automation bot moved this from In Progress to Done in AIP-84 MODERN REST API Nov 28, 2024
@pierrejeambrun pierrejeambrun changed the title AIP-84 Migrate public endpoints from api_connexion to the new rest api AIP-84 Migrate public endpoints from api_connexion to the new Rest API Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AIP-84 Modern Rest API area:API Airflow's REST/HTTP API kind:meta High-level information important to the community
Projects
Development

No branches or pull requests

10 participants