Add fudament for API based on connexion (apache#8149)

.pre-commit-config.yaml

@@ -179,14 +179,13 @@ metastore_browser/templates/.*\\.html$|.*\\.jinja2"
         name: Lint OpenAPI using speccy
         language: docker_image
         entry: wework/speccy lint
-        files: ^openapi.yaml$
+        files: ^airflow/api_connexion/openapi/
       - id: lint-openapi
         name: Lint OpenAPI using openapi-spec-validator
-        entry: openapi-spec-validator --schema 3.0.0 openapi.yaml
+        entry: openapi-spec-validator --schema 3.0.0
         language: python
         additional_dependencies: ['openapi-spec-validator']
-        pass_filenames: false
-        files: ^openapi.yaml$
+        files: ^airflow/api_connexion/openapi/
       - id: lint-dockerfile
         name: Lint dockerfile
         language: system

MANIFEST.in

@@ -34,3 +34,4 @@ graft airflow/config_templates
 recursive-exclude airflow/www/node_modules *
 global-exclude __pycache__  *.pyc
 include airflow/providers/cncf/kubernetes/example_dags/example_spark_kubernetes_operator_spark_pi.yaml
+include airflow/api_connexion/openapi/v1.yaml

airflow/api_connexion/__init__.py

@@ -0,0 +1,16 @@
+# 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.

airflow/api_connexion/endpoints/__init__.py

@@ -0,0 +1,16 @@
+# 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.

airflow/api_connexion/endpoints/config_endpoint.py

@@ -0,0 +1,26 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8136
+
+
+def get_config():
+    """
+    Get current configuration.
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/connection_endpoint.py

@@ -0,0 +1,54 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8127
+
+
+def delete_connection():
+    """
+    Delete a connection entry
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_connection():
+    """
+    Get a connection entry
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_connections():
+    """
+    Get all connection entries
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def patch_connection():
+    """
+    Update a connection entry
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def post_connection():
+    """
+    Create connection entry
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/dag_endpoint.py

@@ -0,0 +1,49 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at:
+#     * https://github.com/apache/airflow/issues/8128
+#     * https://github.com/apache/airflow/issues/8138
+
+
+def get_dag():
+    """
+    Get basic information about a DAG.
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_dag_details():
+    """
+    Get details of DAG.
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_dags():
+    """
+    Get all DAGs.
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def patch_dag():
+    """
+    Update the specific DAG
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/dag_run_endpoint.py

@@ -0,0 +1,61 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8129
+
+
+def delete_dag_run():
+    """
+    Delete a DAG Run
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_dag_run():
+    """
+    Get a DAG Run.
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_dag_runs():
+    """
+    Get all DAG Runs.
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_dag_runs_batch():
+    """
+    Get list of DAG Runs
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def patch_dag_run():
+    """
+    Update a DAG Run
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def post_dag_run():
+    """
+    Trigger a DAG.
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/dag_source_endpoint.py

@@ -0,0 +1,26 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8137
+
+
+def get_dag_source():
+    """
+    Get source code using file token
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/event_log_endpoint.py

@@ -0,0 +1,33 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8135
+
+
+def get_event_log():
+    """
+    Get a log entry
+    """
+    raise NotImplementedError("Not implemented yet.")
+
+
+def get_event_logs():
+    """
+    Get all log entries from event log
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/extra_link_endpoint.py

@@ -0,0 +1,26 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8140
+
+
+def get_extra_links():
+    """
+    Get extra links for task instance
+    """
+    raise NotImplementedError("Not implemented yet.")

airflow/api_connexion/endpoints/health_endpoint.py

@@ -0,0 +1,26 @@
+# 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.
+
+# TODO(mik-laj): We have to implement it.
+#     Do you want to help? Please look at: https://github.com/apache/airflow/issues/8144
+
+
+def get_health():
+    """
+    Checks if the API works
+    """
+    return "OK"