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

Open
1 task done
pierrejeambrun opened this issue Sep 20, 2024 · 21 comments
Open
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 focus 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)

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)

Event Logs (2 endpoints)

Extra Link (1 endpoint)

Monitor (2 endpoints)

Import Error (2 endpoints)

Log (1 endpoint)

Plugin (1 endpoint)

Pool (5 endpoints) @pierrejeambrun

Provider (1 endpoint)

Task (2 endpoints) @omkar-foss

Task Instance (15 endpoints)

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!

@rawwar
Copy link
Collaborator

rawwar commented Oct 2, 2024

I am working on the following

  1. get_connection - AIP-84 Migrate GET connection to FastAPI API #42674
  2. get_connections - AIP-84 Migrate the public endpoint Get Connections to FastAPI  #42677

@potiuk
Copy link
Member

potiuk commented Oct 3, 2024

That would be great, the minimum Pydantic version that is fixed is v2.6.4, this commit for quick reference.

Added min version for Pydantic in #42694

@pierrejeambrun
Copy link
Member Author

pierrejeambrun commented Oct 3, 2024

@rawwar

I am working on the following

get_connection - #42674
get_connections - AIP-84 Migrate the public endpoint Get Connections to FastAPI #42677`

Thanks for your contribution and help on AIP-84, as mentioned above, I think @bugraoz93 is already working on connections endpoints, or is planning to do so. Feel free to choose any other endpoints that looks cool to you, under api_connexions/endpoints. Besides dag_endpoint and connection_endpoint eveything is up for a grab, just let me know and I will assign you :)

@pierrejeambrun
Copy link
Member Author

Assigning myself to variables

@omkar-foss
Copy link
Collaborator

I've created new issues for sections Dag Source (1 endpoint), Dag Stats (1 endpoint), Task (2 endpoints) and Version (1 endpoint). List as below:

  1. AIP-84 Migrate the public endpoint Get DAG Source to FastAPI #42876
  2. AIP-84 Migrate the public endpoint Get DAG Stats to FastAPI #42877
  3. AIP-84 Migrate the public endpoint Get Task to FastAPI #42874
  4. AIP-84 Migrate the public endpoint Get Tasks to FastAPI #42875
  5. AIP-84 Migrate the public endpoint Get Airflow Version Info to FastAPI #42879

Please assign these to me, I'll pick these up one by one in the next few days, right after #42650. Cheers.

@pierrejeambrun
Copy link
Member Author

@omkar-foss assigned and meta issue updated, thanks :)

@michaeljs-c
Copy link
Contributor

Hi @pierrejeambrun I've added issues for XCom, please assign to me 🙂 thanks

@pierrejeambrun
Copy link
Member Author

Hi @pierrejeambrun I've added issues for XCom, please assign to me 🙂 thanks

Done, and meta task is updated.

Thanks for taking those ones @michaeljs-c!

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
None yet
Development

No branches or pull requests

7 participants