Skip to content

Commit

Permalink
Make sure to use openapi v3 for the new builds
Browse files Browse the repository at this point in the history
  • Loading branch information
duncte123 committed May 28, 2022
1 parent af1187b commit dd2bd20
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.idea/
redoc-static.html
oengus-docs.json
3 changes: 1 addition & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ WORKDIR /redoc

RUN npm -g install redoc-cli
COPY template.hbs ./
RUN redoc-cli bundle https://oengus.io/api/v2/api-docs -t template.hbs
RUN redoc-cli build https://oengus.io/api/v3/api-docs -t template.hbs
RUN ls -hal



# 2. serve html with nginx
FROM alpine:latest
WORKDIR /var/www/html
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
# Oengus documentation
Served at https://docs.oengus.io/

# Development

```sh
# Either use this
npx @redocly/openapi-cli preview-docs http://localhost:8080/v3/api-docs -p 8000
# Or do this instead and use your own http server
npm -g install redoc-cli
redoc-cli build http://localhost:8080/v3/api-docs -t template.hbs
```
4 changes: 2 additions & 2 deletions template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
padding: 0;
margin: 0;
padding: 0;
margin: 0;
}
</style>
{{{redocHead}}}
Expand Down

0 comments on commit dd2bd20

Please sign in to comment.