kaxil commented on a change in pull request #9771: URL: https://github.com/apache/airflow/pull/9771#discussion_r453244338
########## File path: docs/stable-rest-api/migration.rst ########## @@ -0,0 +1,180 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +MIGRATION GUIDE FROM EXPERIMENTAL API TO STABLE API v1 +====================================================== +This article provides guidelines for migrating from experimental REST API to the +stable REST API. + +Introduction +------------ +If your application is still using the experimental API, it is important to +consider migrating to the stable API so that your application continues to +work. + +The stable API exposes many endpoints available through the webserver. Here are the +differences between the two endpoints that will help you in migrating from the +experimental REST API to the stable REST API. + +Base Endpoint +^^^^^^^^^^^^^ +The base endpoint for the stable API v1 is ``/api/v1/``. You must change the +experimental base endpoint from ``/api/experimental/`` to ``/api/v1/``. + +Create a dag_run from a given dag_id +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The endpoint for creating a dag_run from a given dag_id have changed from + +.. http:post:: /api/experimental/dags/<DAG_ID>/dag_runs + +to + +.. http:post:: /api/v1/dags/{dag_id}/dagRuns + + +List dag_runs from a specific DAG ID +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The endpoint to get list of dag_runs for a specific dag_id have changed from + +.. http:get:: /api/experimental/dags/<DAG_ID>/dag_runs + +to + +.. http:get:: /api/v1/dags/{dag_id}/dagRuns + +This endpoint also allows you to filter dag_runs with parameters such as start +date, end date, execution date etc in the query string. +Therefore the operation previously performed by this endpoint + +.. http:get:: /api/experimental/dags/<string:dag_id>/dag_runs/<string:execution_date> + +can now be handled with filter parameters in the query string. Please check the +reference documentaion for more information + +Health endpoint +^^^^^^^^^^^^^^^ +The operation previously performed in the experimental REST API endpoint to check +the health status have changed from Review comment: ```suggestion The operation previously performed in the experimental REST API endpoint to check the health status has changed from ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
