mik-laj opened a new pull request #9806: URL: https://github.com/apache/airflow/pull/9806
Hello, Close: https://github.com/apache/airflow/issues/8119 I added reference documentation to our documentation in Sphinx. I analyzed two [Swagger UI](https://petstore.swagger.io/#/) and [Redoc](https://redocly.github.io/redoc/#tag/pet) tools, but I decided to integrate Redoc for two reasons. First of all, it is possible to add code samples of using the client API in different languages thanks to the [x-codesamples](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codeSamples) extension. This will facilitate the use of this API very much and will also provide ready documentation for these clients. Less duplicate documentation. Secondly, Redoc is just two files: 1 HTML and 1 JS, so its integration is very simple. :-D Best regards, Kamil BreguĊa --- Make sure to mark the boxes below before creating PR: [x] - [X] Description above provides context of the change - [X] Unit tests coverage for changes (not needed for documentation changes) - [X] Target Github ISSUE in description if exists - [X] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)" - [X] Relevant documentation is updated including usage instructions. - [X] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example). --- In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed. In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x). In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md). Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information. ---------------------------------------------------------------- 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]
