Skip to content

Commit 9f3e6bd

Browse files
authored
Merge pull request #46 from splitwise/openapi
Switch to OpenAPI v3 + redoc
2 parents dc6db3c + d4fbac6 commit 9f3e6bd

101 files changed

Lines changed: 3224 additions & 16281 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 0 additions & 117 deletions
This file was deleted.

Gemfile

Lines changed: 0 additions & 12 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 136 deletions
This file was deleted.

LICENSE

Lines changed: 0 additions & 13 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ If something in the API is confusing you, you can open an [issue](https://github
88

99
If you spot an issue in our API documentation itself, feel free to open a [pull request](https://github.com/splitwise/api-docs/pulls) to update this repo! Most of the relevant files live in the [/source/includes](https://github.com/splitwise/api-docs/tree/master/source/includes) directory.
1010

11-
## Powered by Slate
11+
## Powered by OpenAPI + redocly
1212

13-
These API docs were built with [Slate](https://github.com/lord/slate). If you're looking to build an API documentation page for your own app, we'd highly recommend it 🙂
13+
These API docs follow the [OpenAPI v3](https://swagger.io/specification/) specification. The website is built with [redoc](https://github.com/Redocly/redoc).
14+
15+
### Developing
16+
```
17+
$ npm install -g redoc-cli
18+
$ redoc-cli serve splitwise.yaml --watch
19+
```
20+
21+
### Compiling
22+
This will create a zero-dependency HTML file at docs/index.html.
23+
24+
```
25+
$ redoc-cli bundle splitwise.yaml -o docs/
26+
```

Vagrantfile

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)