Skip to content

Commit

Permalink
Darren/chore/update apidocs (#925)
Browse files Browse the repository at this point in the history
* chore(openapi): update UI versions and refactor thor.yaml

* fix: update versions

* Update api/doc/README.md

---------

Co-authored-by: otherview <otherview@gmail.com>
  • Loading branch information
darrenvechain and otherview authored Dec 17, 2024
1 parent a638cbd commit 5867f22
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
14 changes: 8 additions & 6 deletions api/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

swagger-ui from https://github.com/swagger-api/swagger-ui @v5.11.2
- Created [window-observer.js](./swagger-ui/window-observer.js) to remove `Try it out` functionality for subscription endpoints
- See the latest version [here](https://unpkg.com/browse/swagger-ui-dist@5.18.2/)

```bash
curl https://unpkg.com/swagger-ui-dist@5.11.2/swagger-ui.css > swagger-ui/swagger-ui.css
curl https://unpkg.com/swagger-ui-dist@5.11.2/swagger-ui-bundle.js > swagger-ui/swagger-ui-bundle.js
curl https://unpkg.com/swagger-ui-dist@5.11.2/swagger-ui-standalone-preset.js > swagger-ui/swagger-ui-standalone-preset.js
curl https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui.css > swagger-ui/swagger-ui.css
curl https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-bundle.js > swagger-ui/swagger-ui-bundle.js
curl https://unpkg.com/swagger-ui-dist@5.18.2/swagger-ui-standalone-preset.js > swagger-ui/swagger-ui-standalone-preset.js
```

## Stoplight
Spotlight UI from https://github.com/stoplightio/elements @v8.0.3
Spotlight UI from https://github.com/stoplightio/elements @v8.5.2
- Created [window-observer.js](./stoplight-ui/window-observer.js) to remove `Send API Request` functionality for subscription endpoints
- See the latest version [here](https://unpkg.com/browse/@stoplight/elements-core@8.5.2/)

```bash
curl https://unpkg.com/@stoplight/elements@8.0.3/styles.min.css > stoplight-ui/styles.min.css
curl https://unpkg.com/@stoplight/elements@8.0.3/web-components.min.js > stoplight-ui/web-components.min.js
curl https://unpkg.com/@stoplight/elements@8.5.2/styles.min.css > stoplight-ui/styles.min.css
curl https://unpkg.com/@stoplight/elements@8.5.2/web-components.min.js > stoplight-ui/web-components.min.js
```
2 changes: 1 addition & 1 deletion api/doc/stoplight-ui/styles.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/doc/stoplight-ui/web-components.min.js

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions api/doc/swagger-ui/swagger-ui-bundle.js

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions api/doc/swagger-ui/swagger-ui-standalone-preset.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/doc/swagger-ui/swagger-ui.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/doc/thor.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ info:
license:
name: LGPL 3.0
url: https://www.gnu.org/licenses/lgpl-3.0.en.html
version: 2.1.5
version: 2.1.6
servers:
- url: /
description: Current Node
Expand Down
2 changes: 1 addition & 1 deletion cmd/thor/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.5
2.1.6

0 comments on commit 5867f22

Please sign in to comment.