From f4470ed61da651d6a5a3859252b14b7dc125fa4e Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Fri, 9 Feb 2024 17:25:25 -0500 Subject: [PATCH] docs: update SwaggerUI version (#12518) - fixed one merge conflict with the `pull_request_template.md` where the Sustainability Effort mention was not backported to release-3.5 Signed-off-by: Anton Gilgur Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> (cherry picked from commit 2e9c1ca43eb02255b814b5ec54b540a1a9f28ccd) --- .github/pull_request_template.md | 3 +-- Makefile | 6 +++--- docs/swagger.md | 37 +++++++++++--------------------- 3 files changed, 16 insertions(+), 30 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 99399333d82a..4be6a8b1ca0f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - + - ### Verification diff --git a/Makefile b/Makefile index ff423124caf8..7d8e31f84ae2 100644 --- a/Makefile +++ b/Makefile @@ -684,7 +684,7 @@ endif .PHONY: docs-spellcheck docs-spellcheck: /usr/local/bin/mdspell # check docs for spelling mistakes - mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name swagger.md -not -name executor_swagger.md -not -path '*/cli/*') + mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name executor_swagger.md -not -path '*/cli/*') # alphabetize spelling file -- ignore first line (comment), then sort the rest case-sensitive and remove duplicates $(shell cat .spelling | awk 'NR<2{ print $0; next } { print $0 | "LC_COLLATE=C sort" }' | uniq | tee .spelling > /dev/null) @@ -697,7 +697,7 @@ endif .PHONY: docs-linkcheck docs-linkcheck: /usr/local/bin/markdown-link-check # check docs for broken links - markdown-link-check -q -c .mlc_config.json $(shell find docs -name '*.md' -not -name fields.md -not -name swagger.md -not -name executor_swagger.md) + markdown-link-check -q -c .mlc_config.json $(shell find docs -name '*.md' -not -name fields.md -not -name executor_swagger.md) /usr/local/bin/markdownlint: # update this in Nix when upgrading it here @@ -709,7 +709,7 @@ endif .PHONY: docs-lint docs-lint: /usr/local/bin/markdownlint # lint docs - markdownlint docs --fix --ignore docs/fields.md --ignore docs/executor_swagger.md --ignore docs/swagger.md --ignore docs/cli --ignore docs/walk-through/the-structure-of-workflow-specs.md + markdownlint docs --fix --ignore docs/fields.md --ignore docs/executor_swagger.md --ignore docs/cli --ignore docs/walk-through/the-structure-of-workflow-specs.md /usr/local/bin/mkdocs: # update this in Nix when upgrading it here diff --git a/docs/swagger.md b/docs/swagger.md index ee0ae0a718e7..20865b65cbce 100644 --- a/docs/swagger.md +++ b/docs/swagger.md @@ -1,27 +1,14 @@ # API Reference - - - - - - - SwaggerUI - - - -
- - - - + +
+ + +