Skip to content

Commit 1832615

Browse files
devalogdevalog
committed
Merge branch 'main' of https://github.com/fern-api/docs into devin/1761574359-document-codeblock-deep-linking
2 parents 4c80cb3 + 0837d9f commit 1832615

File tree

10 files changed

+316
-98
lines changed

10 files changed

+316
-98
lines changed

‎.github/workflows/vale.yml‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +0,0 @@
1-
name: Vale style check
2-
on:
3-
pull_request:
4-
paths:
5-
- '**.mdx'
6-
- '**.md'
7-
- '.vale/**'
8-
- '.vale.ini'
9-
10-
jobs:
11-
vale:
12-
runs-on: ubuntu-latest
13-
if: |
14-
github.event.pull_request.user.login != 'fern-support' &&
15-
github.event.pull_request.user.login != 'github-actions'
16-
steps:
17-
- uses: actions/checkout@v4
18-
19-
- uses: errata-ai/vale-action@reviewdog
20-
with:
21-
files: fern
22-
version: 3.12.0
23-
env:
24-
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎fern/apis/fai/openapi.json‎

Lines changed: 198 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -2035,6 +2035,125 @@
20352035
]
20362036
}
20372037
},
2038+
"/scribe/callback/slack/{team_id}/{channel_id}/{thread_ts}": {
2039+
"post": {
2040+
"tags": [
2041+
"Scribe"
2042+
],
2043+
"summary": "Scribe Slack Callback",
2044+
"description": "Callback endpoint for Scribe to post PR URLs back to Slack threads.",
2045+
"operationId": "scribe_slack_callback",
2046+
"parameters": [
2047+
{
2048+
"name": "team_id",
2049+
"in": "path",
2050+
"required": true,
2051+
"schema": {
2052+
"type": "string",
2053+
"title": "Team Id"
2054+
}
2055+
},
2056+
{
2057+
"name": "channel_id",
2058+
"in": "path",
2059+
"required": true,
2060+
"schema": {
2061+
"type": "string",
2062+
"title": "Channel Id"
2063+
}
2064+
},
2065+
{
2066+
"name": "thread_ts",
2067+
"in": "path",
2068+
"required": true,
2069+
"schema": {
2070+
"type": "string",
2071+
"title": "Thread Ts"
2072+
}
2073+
}
2074+
],
2075+
"requestBody": {
2076+
"required": true,
2077+
"content": {
2078+
"application/json": {
2079+
"schema": {
2080+
"$ref": "#/components/schemas/ScribeSlackCallbackRequest"
2081+
}
2082+
}
2083+
}
2084+
},
2085+
"responses": {
2086+
"200": {
2087+
"description": "Successful Response",
2088+
"content": {
2089+
"application/json": {
2090+
"schema": {
2091+
"$ref": "#/components/schemas/ScribeSlackCallbackResponse"
2092+
}
2093+
}
2094+
}
2095+
},
2096+
"422": {
2097+
"description": "Validation Error",
2098+
"content": {
2099+
"application/json": {
2100+
"schema": {
2101+
"$ref": "#/components/schemas/HTTPValidationError"
2102+
}
2103+
}
2104+
}
2105+
}
2106+
},
2107+
"x-fern-audiences": [
2108+
"internal"
2109+
]
2110+
}
2111+
},
2112+
"/scribe/test/domain-to-repo": {
2113+
"get": {
2114+
"tags": [
2115+
"Scribe"
2116+
],
2117+
"summary": "Test Domain To Repo",
2118+
"operationId": "test_domain_to_repo",
2119+
"parameters": [
2120+
{
2121+
"name": "domain",
2122+
"in": "query",
2123+
"required": true,
2124+
"schema": {
2125+
"type": "string",
2126+
"title": "Domain"
2127+
}
2128+
}
2129+
],
2130+
"responses": {
2131+
"200": {
2132+
"description": "Successful Response",
2133+
"content": {
2134+
"application/json": {
2135+
"schema": {
2136+
"$ref": "#/components/schemas/DomainRepoResponse"
2137+
}
2138+
}
2139+
}
2140+
},
2141+
"422": {
2142+
"description": "Validation Error",
2143+
"content": {
2144+
"application/json": {
2145+
"schema": {
2146+
"$ref": "#/components/schemas/HTTPValidationError"
2147+
}
2148+
}
2149+
}
2150+
}
2151+
},
2152+
"x-fern-audiences": [
2153+
"internal"
2154+
]
2155+
}
2156+
},
20382157
"/settings/ask-ai": {
20392158
"get": {
20402159
"tags": [
@@ -2467,23 +2586,24 @@
24672586
]
24682587
}
24692588
},
2470-
"/slack/integrations": {
2589+
"/slack/install": {
24712590
"post": {
24722591
"tags": [
24732592
"Slack"
24742593
],
24752594
"summary": "Create Slack Integration",
24762595
"operationId": "create_slack_integration",
2477-
"requestBody": {
2478-
"content": {
2479-
"application/json": {
2480-
"schema": {
2481-
"$ref": "#/components/schemas/CreateSlackIntegration"
2482-
}
2596+
"parameters": [
2597+
{
2598+
"name": "domain",
2599+
"in": "query",
2600+
"required": true,
2601+
"schema": {
2602+
"type": "string",
2603+
"title": "Domain"
24832604
}
2484-
},
2485-
"required": true
2486-
},
2605+
}
2606+
],
24872607
"responses": {
24882608
"200": {
24892609
"description": "Successful Response",
@@ -2507,7 +2627,12 @@
25072627
}
25082628
},
25092629
"x-fern-audiences": [
2510-
"internal"
2630+
"customers"
2631+
],
2632+
"security": [
2633+
{
2634+
"bearerAuth": []
2635+
}
25112636
]
25122637
}
25132638
},
@@ -2726,49 +2851,6 @@
27262851
"internal"
27272852
]
27282853
}
2729-
},
2730-
"/slack/get-install/{integration_id}": {
2731-
"get": {
2732-
"tags": [
2733-
"Slack"
2734-
],
2735-
"summary": "Get Slack Install Link By Id",
2736-
"operationId": "get_slack_install_link_by_id",
2737-
"parameters": [
2738-
{
2739-
"name": "integration_id",
2740-
"in": "path",
2741-
"required": true,
2742-
"schema": {
2743-
"type": "string",
2744-
"title": "Integration Id"
2745-
}
2746-
}
2747-
],
2748-
"responses": {
2749-
"200": {
2750-
"description": "Successful Response",
2751-
"content": {
2752-
"application/json": {
2753-
"schema": {}
2754-
}
2755-
}
2756-
},
2757-
"422": {
2758-
"description": "Validation Error",
2759-
"content": {
2760-
"application/json": {
2761-
"schema": {
2762-
"$ref": "#/components/schemas/HTTPValidationError"
2763-
}
2764-
}
2765-
}
2766-
}
2767-
},
2768-
"x-fern-audiences": [
2769-
"internal"
2770-
]
2771-
}
27722854
}
27732855
},
27742856
"components": {
@@ -3118,19 +3200,6 @@
31183200
],
31193201
"title": "CreateQueryResponse"
31203202
},
3121-
"CreateSlackIntegration": {
3122-
"properties": {
3123-
"domain": {
3124-
"type": "string",
3125-
"title": "Domain"
3126-
}
3127-
},
3128-
"type": "object",
3129-
"required": [
3130-
"domain"
3131-
],
3132-
"title": "CreateSlackIntegration"
3133-
},
31343203
"DeleteDocumentRequest": {
31353204
"properties": {
31363205
"document_id": {
@@ -3295,6 +3364,31 @@
32953364
],
32963365
"title": "Document"
32973366
},
3367+
"DomainRepoResponse": {
3368+
"properties": {
3369+
"domain": {
3370+
"type": "string",
3371+
"title": "Domain"
3372+
},
3373+
"repo": {
3374+
"anyOf": [
3375+
{
3376+
"type": "string"
3377+
},
3378+
{
3379+
"type": "null"
3380+
}
3381+
],
3382+
"title": "Repo"
3383+
}
3384+
},
3385+
"type": "object",
3386+
"required": [
3387+
"domain",
3388+
"repo"
3389+
],
3390+
"title": "DomainRepoResponse"
3391+
},
32983392
"Feedback": {
32993393
"properties": {
33003394
"query_id": {
@@ -4008,6 +4102,37 @@
40084102
],
40094103
"title": "ReconstructIndexResponse"
40104104
},
4105+
"ScribeSlackCallbackRequest": {
4106+
"properties": {
4107+
"pr_url": {
4108+
"type": "string",
4109+
"title": "Pr Url"
4110+
}
4111+
},
4112+
"type": "object",
4113+
"required": [
4114+
"pr_url"
4115+
],
4116+
"title": "ScribeSlackCallbackRequest"
4117+
},
4118+
"ScribeSlackCallbackResponse": {
4119+
"properties": {
4120+
"status": {
4121+
"type": "string",
4122+
"title": "Status"
4123+
},
4124+
"status_code": {
4125+
"type": "integer",
4126+
"title": "Status Code"
4127+
}
4128+
},
4129+
"type": "object",
4130+
"required": [
4131+
"status",
4132+
"status_code"
4133+
],
4134+
"title": "ScribeSlackCallbackResponse"
4135+
},
40114136
"SlackIntegrationResponse": {
40124137
"properties": {
40134138
"integration_id": {
@@ -4056,13 +4181,18 @@
40564181
}
40574182
],
40584183
"title": "Installed At"
4184+
},
4185+
"integration_url": {
4186+
"type": "string",
4187+
"title": "Integration Url"
40594188
}
40604189
},
40614190
"type": "object",
40624191
"required": [
40634192
"integration_id",
40644193
"domain",
4065-
"created_at"
4194+
"created_at",
4195+
"integration_url"
40664196
],
40674197
"title": "SlackIntegrationResponse"
40684198
},

‎fern/products/cli-api-reference/cli-changelog/2025-10-25.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## 0.96.1
2+
**`(fix):`** Reformat how docs fern check errors are displayed, and error on:
3+
- OpenAPI v2.0 in docs
4+
- Non-component local refs in docs
5+
6+
17
## 0.96.0
28
**`(feat):`** Support using audience tags in products and versions to generate a filtered instance of a docs site.
39

‎fern/products/cli-api-reference/cli-changelog/2025-10-27.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 0.97.0
2+
**`(feat):`** Remove noisy logging from fern generate --docs and add error message for missing local references.
3+
4+

‎fern/products/docs/pages/api-references/audiences.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,12 @@ navigation:
2020
</CodeBlocks>
2121
2222
Here's [an example from Schematic](https://github.com/SchematicHQ/schematic-fern-config/blob/e19f5ea69a343727ed018e79127bf4fd20ad0f7b/fern/docs.yml#L128-L129) in production.
23+
24+
## Instance audiences
25+
26+
API Reference audiences work alongside [instance audiences](/docs/configuration/products#add-instance-audiences), which control which products and versions appear in each documentation instance. You can use both features together:
27+
28+
- **API Reference audiences** - Control which endpoints and schemas appear within API References
29+
- **Instance audiences** - Control which products and versions appear in each instance
30+
31+
For example, you might have a `public` API Reference that shows only public endpoints. To ensure this API Reference only appears on your public documentation site, tag the containing product or version with the `public` audience.

0 commit comments

Comments
 (0)