Skip to content

Commit 22e629c

Browse files
authored
Merge pull request #113 from supabase/feat/openapi
feat: Add preliminary code for generating OAS
2 parents e704781 + 37ad7f6 commit 22e629c

File tree

11 files changed

+7427
-264
lines changed

11 files changed

+7427
-264
lines changed

.github/workflows/docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
jobs:
10+
docs:
11+
name: Publish docs / OS ${{ matrix.os }} / Node ${{ matrix.node }}
12+
strategy:
13+
matrix:
14+
os:
15+
- ubuntu-latest
16+
node:
17+
- '12'
18+
19+
runs-on: ${{ matrix.os }}
20+
21+
steps:
22+
- uses: actions/checkout@v2
23+
24+
- uses: actions/setup-node@v2
25+
with:
26+
node-version: ${{ matrix.node }}
27+
28+
- run: |
29+
npm ci
30+
npm run docs:export
31+
32+
- name: Generate Swagger UI
33+
uses: Legion2/swagger-ui-action@v1
34+
with:
35+
output: docs
36+
spec-file: openapi.json
37+
38+
- name: Publish
39+
uses: peaceiris/actions-gh-pages@v3
40+
with:
41+
github_token: ${{ secrets.GITHUB_TOKEN }}
42+
publish_dir: docs
43+
force_orphan: true
44+
commit_message: 'docs: update'

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,6 @@ dist/
108108

109109
# Binaries
110110
bin/
111+
112+
# postgres-meta
113+
openapi.json

docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
version: "3"
33
services:
44
db:
5-
image: supabase/postgres:0.14.0
5+
image: postgres:13
66
ports:
77
- "5432:5432"
88
volumes:

0 commit comments

Comments
 (0)