refactor(deps)!: remove swagger-ui-react

[agilgur5]

Partial fix for #13410 -- see #13821 for the other half to downgrade react that is a pure fix (vs this is a breaking change that is sizeable in its own right)
Replaces #13069 to resolve CVEs by just removing swagger-ui-react entirely

• c.f. fix(deps): upgrade swagger-ui-react v5.17.3, react-dom v18.3.1, and react v18.3.1. Fixes CVEs #13069 (review), Slack thread, Release v3.5 patch releases discussion #11997 (comment), etc

Motivation

Removes the Swagger UI entirely from the UI as it is a gigantic dep (2nd largest only behind Monaco Editor) and often has vulnerable dependencies that are difficult to resolve without affecting other deps. According to #12061, this would shave off ~2MB / 826KB minified / 250KB gzipped from the UI bundle and will also speed up builds and installs as such.

It also no longer necessary to have in the UI as there is a Swagger UI in the docs after #10923 and the docs are versioned after #11390

Modifications

• remove swagger-ui-react dep
  • and @types/swagger-ui-react devDep
• replace /apidocs UI page with a few links: download the OpenAPI / Swagger spec, download the JSON schema, and go to the Swagger UI in the versioned documentation
  • uses ZeroState component same as other pages, namely the Plugins page
• replace other UI links to the API Docs with versioned docs links as well
  • could leave them as-is, but they seem to be intended for use with the Swagger UI
  • ensure target='blank' and rel='noreferrer' consistent with existing links in the UI

Docs update

update and simplify REST API page

• client auth and access tokens are already described in other pages, can remove these and just link
• remove bullet about interactive usage in the UI
• update bullet about the swagger reference as it is always up-to-date (it pulls from main) and can be versioned now as well

Verification

Manually tested and confirmed the page works as intended. Screenshot of new API docs page:

Future Work

1. Downgrade React to fix a bunch of compat warnings (and unexpected errors like fix(ui): handle React 18 batching for "Submit" button on details page. Fixes #13453 #13593) etc per above linked javascript dependency warnings -- mostly due to incompatible React  #13410, fix(deps): upgrade swagger-ui-react v5.17.3, react-dom v18.3.1, and react v18.3.1. Fixes CVEs #13069 (comment), etc
   • EDIT: Completed in fix(deps): revert React 18 upgrade back to React 16  #13821
2. Have the versioned API reference page pull its reference from the same version GH, instead of main
   • EDIT: Completed in docs: 3.5 Swagger UI should reference 3.5 OpenAPI spec -- 3.5 specific #13824

[tooptoop4]

if swagger ui is removed from each operator's server should there be an entry in breaking changes/upgrading guide?

[agilgur5]

It is breaking, so we could, although the UI itself tells you what to do and there is no upgrade instruction otherwise. The impacted UI page having a message for a deprecation window for the Archived List UI could have made sense too, i.e. a better option than #13371

I'm inclined to agree and note it in this case, although we do want to be careful about making the UI a "breakable" surface area and where to draw boundaries as it's not quite the same as the schema / API / etc "Public API" (also I noticed metrics are missing there) but rather a consumer of those.

[Joibel]

Could this be added to docs/upgrading.md to note the removal of the feature?

[agilgur5]

Added an upgrading note in d706239

[Joibel]

LGTM, thanks for sorting this one

[Joibel]

@agilgur5, could you resolve the conflicts and then we can merge and cut a 3.6.0-rc4 with this in?

[MasonM]

@Joibel I can take this over if you'd like, though I don't have access to push to https://github.com/agilgur5/argo-workflows/tree/refactor-remove-swagger-ui (which I'm assuming I'll get when my membership request goes through).

I'm assuming the best way forward is to create a new PR with a branch forked from https://github.com/agilgur5/argo-workflows/tree/refactor-remove-swagger-ui. Does that sound reasonable?

[agilgur5]

It requires write access on GH to push to PR, or Approver in Argoproj terms.

I just added you as a collaborator to my fork for simplicity

I'm assuming the best way forward is to create a new PR with a branch forked from

Otherwise that would be the general process that has been done in the past and tends to be an easy way to give proper attribution

[MasonM]

@agilgur5 Thanks! It works, and I resolved the conflicts

[terrytangyuan]

Thanks!