potiuk commented on code in PR #28300: URL: https://github.com/apache/airflow/pull/28300#discussion_r1046561319
########## docs/apache-airflow/public-airflow-api.rst: ########## @@ -0,0 +1,141 @@ + .. 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. + +"Public API" of Airflow +======================= + +The Public API of Apache Airflow is a set of programmatic interfaces that allow developers to interact +with and access certain features of the Apache Airflow system. This can include operations such as +creating and managing DAGs (directed acyclic graphs), managing tasks and their dependencies, +and extending Airflow capabilities by writing new Executors, Plugins, Operators and Providers. The +public API of Apache Airflow can be useful for building custom tools and integrations with other systems, +as well as for automating certain aspects of the Airflow workflow. + +In general, the public API is an important part of the Airflow ecosystem and can be a powerful tool for users +and developers who want to extend the functionality of the system. + +What kind of APIs are Public in Apache Airflow? +=============================================== + +Apache Airflow has a number of different public APIs that allow developers to interact with various +aspects of the system. Some examples of the types of public APIs exposed as Python objects +that are available in Apache Airflow include: + +* :doc:`DAG <concepts/dags>`_ (Directed Acyclic Graph) APIs, which allow developers to create, manage, + and access DAGs in Airflow. +* :doc:`Task <concepts/tasks>`_ APIs, which provide access to information about individual tasks within + a DAG, such as their dependencies and execution status. +* :doc:`Operator <concepts/operators>`_ APIs, which allows the developers to write their custom Operators. +* :doc:`Decorators <howto/create-custom-decorator>`_ APIs, which allows the developers to write their + custom decorators to make it easier to write :doc:`TaskFlow <tutorial/taskflow>`_ DAGs. +* :doc:`Secret Managers <security/secrets>`_ APIs, which allows the developers to write their custom + Secret Managers to safely access credentials and other secret configuration of their workflows. +* :doc:`Connection management <concepts/connections>`_ APIs, which allow developers to manage + connections to external systems +* :doc:`XCom <concepts/xcoms>`_, which allow developers to manage cross-task communication within Airflow. +* :doc:`Variables <concepts/variables>`_, which allow developers to manage variables within Airflow. +* :doc:`Executors <executor/index>`_, which allow developers to manage the execution of tasks within Airflow. +* :doc:`Plugins <plugins>`_, which allow developers to extend internal Airflow capabilities - add new UI + pages, custom :doc:`TimeTables <concepts/timetable>`_, :doc:`Extra Links <howto/define_extra_link>`_, + :doc:`Listeners <listeners>`_ - all of which are considered public APIs. + +Also Airflow has a stable REST API that allows users to interact with Airflow via HTTP requests and a +CLI that allows users to interact with Airflow via command line commands. + +Overall, the public APIs in Apache Airflow are designed to provide developers with a wide +range of tools and capabilities for interacting with the system and extending its functionality. + +What is not part of the Public API of Apache Airflow? +===================================================== + +A public API of Apache Airflow is a set of programming interfaces that are designed to be used +by developers to access certain features and functionality of the system. As such, not everything in +Apache Airflow is considered to be part of the public API. + +For example, the internal implementation details of Apache Airflow, such as the specific algorithms +and data structures used to manage DAGs and tasks, are not considered to be part of the public API. Review Comment: I think we want to be MUCH stronger than that. Anything that is NOT mentioned in this docs should be considered Private. This is what I am adding in the new version of the docs. Currently we have almost no` _` classes in our codebase and we even have no convention agreed that we should do it. I'd say maybe at some point in the future we should have it, but even that I am not sure if we will do it, because this is pretty uncommon in the Python world and it simply looks ugly. So while maybe it is an easy win, I am not sure if we will ever go this direction and adding it at this stage assumes we will. Simply speaking - let's not add a new convention in this doc that we neither have nor agreed to yet. My goal is to document current state at this stage and any future changes to conventions and agreements should be left for, well, future .... -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
