Skip to content

Commit db7326d

Browse files
authored
Merge branch 'main' into devin/1761268929-document-accordion-defaultopen
2 parents 0e8ca87 + 39acfaa commit db7326d

Some content is hidden

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

63 files changed

+680
-377
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# .github/workflows/auto-merge-on-release.yml in docs repo
2+
name: Auto-merge on Docs Release
3+
on:
4+
repository_dispatch:
5+
types: [docs_release]
6+
7+
jobs:
8+
merge-dependent-prs:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Find and merge dependent PRs
12+
uses: actions/github-script@v7
13+
with:
14+
script: |
15+
const version = context.payload.client_payload.version;
16+
17+
// Find PRs with matching labels
18+
const { data: prs } = await github.rest.pulls.list({
19+
owner: context.repo.owner,
20+
repo: context.repo.repo,
21+
state: 'open'
22+
});
23+
24+
for (const pr of prs) {
25+
const labels = pr.labels.map(l => l.name);
26+
const hasLatestLabel = labels.includes('depends-on: docs@latest');
27+
const hasVersionLabel = labels.includes(`depends-on: docs@${version}`);
28+
29+
if (hasLatestLabel || hasVersionLabel) {
30+
// Check if PR is approved and CI passes
31+
const { data: reviews } = await github.rest.pulls.listReviews({
32+
owner: context.repo.owner,
33+
repo: context.repo.repo,
34+
pull_number: pr.number
35+
});
36+
37+
const approved = reviews.some(r => r.state === 'APPROVED');
38+
39+
if (approved) {
40+
await github.rest.pulls.merge({
41+
owner: context.repo.owner,
42+
repo: context.repo.repo,
43+
pull_number: pr.number,
44+
merge_method: 'squash'
45+
});
46+
47+
console.log(`Merged PR #${pr.number}: ${pr.title}`);
48+
}
49+
}
50+
}

.vale/styles/FernStyles/Headings.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,32 @@ exceptions:
8080
- CSS
8181
- HTML
8282
- JSON
83+
- OpenAPI
84+
- AsyncAPI
85+
- Fern Definition
86+
- WebSockets
87+
- MQTT
88+
- JSON-RPC
89+
- Protocol Buffers
90+
- TLS
91+
- JWT
92+
- OAuth2
93+
- API
94+
- CircleCI
95+
- GitLab CI
96+
- CI/CD
97+
- Kubernetes
98+
- Buf
99+
- FastAPI
100+
- PyPI
101+
- Maven
102+
- Spring Boot
103+
- Pydantic
104+
- Postman
105+
- HTTP
106+
- HTTPS
107+
- TCP
108+
- Protobuf
109+
- Proto
110+
- RBAC
111+
- YAML

fern/products/api-def/asyncapi-pages/auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ components:
5959
env: AUTH_TOKEN
6060
```
6161

62-
## API Key security scheme
62+
## API key security scheme
6363

6464
Start by defining an `apiKey` security scheme in your `asyncapi.yml`:
6565

@@ -81,7 +81,7 @@ const client = new Client({
8181
})
8282
```
8383

84-
### Custom API Key variable name
84+
### Custom API key variable name
8585

8686
If you want to control variable naming and the environment variable to scan,
8787
use the configuration below:
@@ -120,7 +120,7 @@ const client = new Client({
120120
})
121121
```
122122

123-
### Custom Basic Auth variable names
123+
### Custom basic auth variable names
124124

125125
If you want to control variable naming and the environment variables to scan,
126126
use the configuration below:

fern/products/api-def/asyncapi-pages/automation.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Sync your AsyncAPI Specification
2+
title: Sync your AsyncAPI specification
33
subtitle: Automatically sync your AsyncAPI spec changes to keep SDKs and docs up to date
44
---
55

@@ -85,7 +85,7 @@ api:
8585
version: 0.8.8
8686
```
8787
88-
### From Git repository
88+
### From git repository
8989
```yaml title="generators.yml" {3-7}
9090
api:
9191
specs:
@@ -200,4 +200,4 @@ api:
200200
version: 0.8.8
201201
```
202202
203-
This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
203+
This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.

fern/products/api-def/asyncapi-pages/extensions/parameter-names.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Parameter Names
2+
title: Parameter names
33
subtitle: Use `x-fern-parameter-name` to customize SDK parameter names for message properties
44
---
55

@@ -76,4 +76,4 @@ channels:
7676
type: string
7777
```
7878
79-
This ensures consistent naming conventions across your SDK while maintaining compatibility with your existing message formats.
79+
This ensures consistent naming conventions across your SDK while maintaining compatibility with your existing message formats.

fern/products/api-def/asyncapi-pages/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: What is an AsyncAPI Specification?
2+
title: What is an AsyncAPI specification?
33
description: AsyncAPI is a standard for documenting event-driven APIs
44
---
55

@@ -174,4 +174,4 @@ fern/
174174
└─ asyncapi.yml
175175
```
176176
</Step>
177-
</Steps>
177+
</Steps>

fern/products/api-def/ferndef-pages/api-yml/global-configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Global Configuration
2+
title: Global configuration
33
description: Specify global headers, path parameters or query parameters meant to be included on every request.
44
---
55

@@ -52,4 +52,4 @@ service:
5252
## Global query parameters
5353

5454
You cannot yet specify query parameters that are meant to be included on every request.
55-
If you'd like to see this feature, please upvote [this issue](https://github.com/fern-api/fern/issues/2930).
55+
If you'd like to see this feature, please upvote [this issue](https://github.com/fern-api/fern/issues/2930).

fern/products/api-def/ferndef-pages/endpoints/bytes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Binary Data and Files
2+
title: Binary data and files
33
subtitle: Use the `bytes` type to handle binary data in your API
44
---
55

fern/products/api-def/ferndef-pages/endpoints/multipart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Multipart File Upload
2+
title: Multipart file upload
33
description: Document endpoints with the `multiform` content type.
44
---
55

@@ -24,7 +24,7 @@ service:
2424
2525
Within a given multipart request, a string parameter with `format:binary` will represent an arbitrary file.
2626

27-
## List of Files
27+
## List of files
2828

2929
If your endpoint supports a list of files, then your request body must indicate such.
3030

fern/products/api-def/ferndef-pages/endpoints/sse.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Server-Sent Events and Streaming APIs
2+
title: Server-sent events and streaming APIs
33
subtitle: Use the `response-stream` key to model streaming endpoints
44
---
55

@@ -97,4 +97,4 @@ types:
9797
ChatChunk:
9898
properties:
9999
text: string
100-
```
100+
```

0 commit comments

Comments
 (0)