Skip to content

Commit

Permalink
Merge pull request #12 from darrellodonnell/main
Browse files Browse the repository at this point in the history
content and specup
  • Loading branch information
darrellodonnell authored Mar 20, 2024
2 parents be80a6d + 687b9f0 commit 28543cb
Show file tree
Hide file tree
Showing 16 changed files with 3,139 additions and 976 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/render-specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
run: |
npm install
node -e "require('./index')({ nowatch: true })"
npm run render
rm -rf node_modules
- name: Deploy
Expand Down
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@ npm run edit
```


## Rendering OpenAPI Specification

In the `./api` folder, run:

```
npx @redocly/cli build-docs toip-tswg-trustregistryprotocol-v2.yaml

```
11 changes: 8 additions & 3 deletions api/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@

# Rendering API Tool

## Rendering OpenAPI Specification

TODO: find alternative
- Scalar? https://github.com/scalar/scalar
In the `./api` folder, run:

```
npx @redocly/cli build-docs toip-tswg-trustregistryprotocol-v2.yaml
```

That produces the [Redoc Rendered OpenAPI Spec](redoc-static.html)
54 changes: 35 additions & 19 deletions api/redoc-static.html

Large diffs are not rendered by default.

Loading

0 comments on commit 28543cb

Please sign in to comment.