docs: 3.5 Swagger UI should reference 3.5 OpenAPI spec -- 3.5 specific - Githubissues

argoproj / argo-workflows

Workflow Engine for Kubernetes

https://argo-workflows.readthedocs.io/

Apache License 2.0

15.11k stars 3.21k forks source link

docs: 3.5 Swagger UI should reference 3.5 OpenAPI spec -- 3.5 specific #13824

Closed agilgur5 closed 3 weeks ago

agilgur5 commented 3 weeks ago

Fixes "Future Work" part 2 of https://github.com/argoproj/argo-workflows/pull/13818

Motivation

As we have versioned docs now (#11390), the Swagger UI should reference the OpenAPI spec of its release, not main

Modifications

In swagger.md, change the raw GH URL from main to release-3.5

I also backported https://github.com/argoproj/argo-workflows/pull/12518#issuecomment-2439824378 to make this page equivalent to main before this change. (the spec was always pointing to main both before and after, for clarity)

Verification

mkdocs build && open site/swagger/index.html
Confirmed that it loads the Swagger UI properly and loads the release-3.5 spec.
Screenshot:

Notes to Reviewers

This PR is specific to the release-3.5 branch

will need to modify this upon backport to release-3.4