Skip to content

Commit

Permalink
docs: update SwaggerUI version (#12518)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <[email protected]>
Signed-off-by: Anton Gilgur <[email protected]>
  • Loading branch information
agilgur5 authored Feb 9, 2024
1 parent ae0973a commit 2e9c1ca
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 34 deletions.
11 changes: 5 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- markdownlint-disable MD041 -->
<!-- markdownlint-disable MD041 -- this is rendered within existing HTML, so allow starting without an H1 -->

<!--
Expand Down Expand Up @@ -30,19 +30,18 @@ Fixes #TODO
### Modifications

<!-- TODO: Say what changes you made. -->

<!-- TODO: Attach screenshots if you changed the UI. -->

### Verification

<!-- TODO: Say how you tested your changes. -->

<!--
<!--
### Beyond this PR
Thank you for submitting this! Have you ever thought of becoming a Reviewer or Approver on the project?
Thank you for submitting this! Have you ever thought of becoming a Reviewer or Approver on the project?
Argo Workflows is seeking more community involvement and ultimately more [Reviewers and Approvers](https://github.com/argoproj/argoproj/blob/main/community/membership.md) to help keep it viable.
See [Sustainability Effort](https://github.com/argoproj/argo-workflows/blob/main/community/sustainability_effort.md) for more information.
Argo Workflows is seeking more community involvement and ultimately more [Reviewers and Approvers](https://github.com/argoproj/argoproj/blob/main/community/membership.md) to help keep it viable.
See [Sustainability Effort](https://github.com/argoproj/argo-workflows/blob/main/community/sustainability_effort.md) for more information.
-->
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,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 | "sort" }' | uniq | tee .spelling > /dev/null)

Expand All @@ -698,7 +698,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
Expand All @@ -710,7 +710,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
Expand Down
37 changes: 12 additions & 25 deletions docs/swagger.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,14 @@
# API Reference

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="SwaggerUI"
/>
<title>SwaggerUI</title>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle({
url: "https://raw.githubusercontent.com/argoproj/argo-workflows/main/api/openapi-spec/swagger.json",
dom_id: "#swagger-ui",
});
};
</script>
</body>
</html>
<!-- markdownlint-disable MD033 -- allow inline HTML -->
<div id="swagger-ui"></div>
<link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
<script>
window.onload = function loadSwaggerUI() {
window.ui = SwaggerUIBundle({
url: "https://raw.githubusercontent.com/argoproj/argo-workflows/main/api/openapi-spec/swagger.json",
dom_id: "#swagger-ui",
});
};
</script>

0 comments on commit 2e9c1ca

Please sign in to comment.