Skip to content

Commit 0c7620c

Browse files
committed
Better validate spec using openAPI output
1 parent 88f87c2 commit 0c7620c

File tree

16 files changed

+704
-47
lines changed

16 files changed

+704
-47
lines changed

docs/SUMMARY.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Sumamry
2+
3+
- [Welcome](README.md)
4+
- [Quickstart](quickstart.md)
5+
6+
## Integrations
7+
8+
- [Overview](integrations/README.md)
9+
- [Configurations](integrations/configurations.md)
10+
- [Runtime](integrations/runtime/README.md)
11+
- [Runtime APIs](integrations/runtime/apis.md)
12+
- Environment
13+
- [HTTP Fetch](integrations/fetch.md)
14+
15+
## API
16+
17+
- Overview
18+
- References
19+
- Spaces
20+
- Content
21+
- Views
22+
- Change Requests
23+
- Users
24+
- Organizations
25+
- Integrations
26+
- Installations
27+
- Clients
28+
- Browser / Node
29+

docs/integrations/README.md

Whitespace-only changes.

docs/integrations/runtime/README.md

Whitespace-only changes.

docs/integrations/runtime/apis.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Runtime API
2+
3+
## `addEventListener()`
4+
5+
## `fetch()`
6+
7+
## `Response`
8+
9+
## `Request`
10+
11+
## `URL`
12+
13+
## `URLSearchParam`
14+

docs/quickstart.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# Quickstart
22

3-
## Step 1: Install the GitBook CLI
3+
### Step 1: Install the GitBook CLI
44

55
The GitBook Development CLI requires Node v18 or later. It can be installed from NPM using:
66

77
```
88
npm install @gitbook/cli -g
99
```
10+
11+
### Step 2: Authenticate with your account
12+
13+
Create an API token in your GitBook.com at [app.gitbook.com/account/developer](https://app.gitbook.com/account/developer).
14+
15+
Then run the following command to authenticate locally:
16+
17+
```
18+
gitbook auth
19+
```

integrations/slack/icon.png

46.5 KB
Loading

integrations/slack/integration.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
name: slack
22
title: Slack
3+
icon: ./icon.png
34
description: Notify a channel or individual in Slack with real-time events from GitBook.
45
script: ./script.ts
56
scopes:
@@ -21,6 +22,11 @@ configurations:
2122
title: Channel
2223
description: Select a channel to post message to.
2324
completion_url: /conversations
25+
notify_content_update:
26+
type: boolean
27+
title: Notify Content Update
28+
description: Post a notification message every time the content of the space is updated.
29+
default: true
2430
required:
2531
- oauth_credentials
2632
- conversation

0 commit comments

Comments
 (0)