Wow, super cool! Thanks, Jens! Best, Wei
Pierre Jeambrun <[email protected]> 於 2026年5月29日週五 下午3:57寫道: > Looks good thanks for taking a look Jens. > > I feel like redoc displayed a few more info and in a clearer way > (authentication part for instance) and displayed better on mobile (its > overflowing horizontally for some reason), but if that’s holding us back we > should probably switch. > > On Thu 28 May 2026 at 23:42, Stefan Wang <[email protected]> wrote: > > > Ha — it's crazy that I've never once clicked that swagger ui page in > years > > of building / operating Airflow… > > > > Checking it out now, thanks. > > > > Stefan > > > > > On May 28, 2026, at 1:46 PM, Jens Scheffler <[email protected]> > wrote: > > > > > > Hi Stefan, > > > > > > Swagger (and Redoc) are always rendered within the "Docs" Menu in > > Airflow 2 and Airflow 3 - including "Try it out" - So the official > > published documentation is only an offline replica. > > > > > > Jens > > > > > > On 28.05.26 22:43, Stefan Wang wrote: > > >> +1 > > >> > > >> thanks Jens > > >> > > >> clicked through the staged Core REST API and the new Edge3 page > > >> > > >> the render is clean and easier to scan than the current Redoc. > > >> > > >> We might port this into our internal airflow deployment and make the > > Swagger “Try it out” functionally work internally for our Airflow Users > :p > > >> Stefan > > >> > > >>> On May 27, 2026, at 7:47 PM, Nikolas Oliveira <[email protected] > > > > wrote: > > >>> > > >>> Looks great to me, thanks for doing this Jens! > > >>> > > >>> On Wed, May 27, 2026 at 4:55 PM Jarek Potiuk <[email protected]> > wrote: > > >>> > > >>>> Very nice. While the docs look less "doc-like" - they are far more > > usable > > >>>> :) > > >>>> > > >>>> On Wed, May 27, 2026 at 11:07 PM Shahar Epstein <[email protected]> > > wrote: > > >>>> > > >>>>> Great initiative Jens! > > >>>>> > > >>>>> > > >>>>> Shahat > > >>>>> > > >>>>> > > >>>>> On Wed, May 27, 2026, 22:12 Jens Scheffler <[email protected]> > > wrote: > > >>>>> > > >>>>>> Hi Airflow Devs, > > >>>>>> > > >>>>>> since a while a deprecation in sphinx-redoc holds us back in > > upgrading > > >>>>>> setuptools, our attempt to contribute a fix is not helping as the > > >>>>>> sphinx-contrib seems to be un-maintained (see > > >>>>>> https://github.com/sphinx-contrib/redoc/pull/54). Unless we fork > or > > >>>> find > > >>>>>> other means we need to upper-pin setuptools because of breaking > > change > > >>>>>> in setuptools. > > >>>>>> > > >>>>>> Therefore I looked a bit around and propose to replace Redoc in > our > > >>>>>> Sphinx docbuild with Swagger using the "swagger-plugin-for-sphinx" > > (see > > >>>>>> https://github.com/SAP/swagger-plugin-for-sphinx) which seems > > better > > >>>>>> maintained (and I contributed a small feature few days ago in > > 7.1.0). > > >>>>>> > > >>>>>> I prepared the PR https://github.com/apache/airflow/pull/67390 to > > show > > >>>>>> and also pushed some generated dcos with this to our staged site: > > >>>>>> > > >>>>>> * Airflow Core: > > >>>>>> > > >>>>>> > > >>>> > > > https://airflow.staged.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html > > >>>>>> * Simple Auth Manager API: > > >>>>>> > > >>>>>> > > >>>> > > > https://airflow.staged.apache.org/docs/apache-airflow/stable/core-concepts/auth-manager/simple/sam-token-api-ref.html > > >>>>>> * FAB: > > >>>>>> > > >>>>>> > > >>>> > > > https://airflow.staged.apache.org/docs/apache-airflow-providers-fab/stable/api-ref/fab-api-ref.html > > >>>>>> * Keycloak: > > >>>>>> > > >>>>>> > > >>>> > > > https://airflow.staged.apache.org/docs/apache-airflow-providers-keycloak/stable/api-ref/token-api-ref.html > > >>>>>> * Edge3 (new! in this PR, now also has API docs!): > > >>>>>> > > >>>>>> > > >>>> > > > https://airflow.staged.apache.org/docs/apache-airflow-providers-edge3/stable/edge-api-ref.html > > >>>>>> Is anybody against this or shall we raise a discussion on this? > Else > > >>>> I'd > > >>>>>> hope with nobody objecting propose to merge this, if desired can > > make a > > >>>>>> LAZY CONSENSUS as well but only if a discussion arises, else it is > > >>>>>> rather treated as a smaller SW change. > > >>>>>> > > >>>>>> Jens > > >>>>>> > > >> > > >> --------------------------------------------------------------------- > > >> To unsubscribe, e-mail: [email protected] > > >> For additional commands, e-mail: [email protected] > > >> > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: [email protected] > > > For additional commands, e-mail: [email protected] > > > > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [email protected] > > For additional commands, e-mail: [email protected] > > > > >
