Skip to content

Commit e8e3663

Browse files
authored
chore: fix endpoint schema docs (#1398)
1 parent 8deffb9 commit e8e3663

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ to specify the path to the schema you want to reference. The available selectors
2121

2222
The following markdown:
2323
```jsx
24-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="request" />
24+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request" />
2525
```
2626
will be rendered as:
2727
<br/>
28-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="request" />
28+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request" />
2929
</Card>
3030
</Tab>
3131
<Tab title="Path">
@@ -34,13 +34,11 @@ to specify the path to the schema you want to reference. The available selectors
3434
<br/>
3535
The following markdown:
3636
```jsx
37-
<EndpointSchemaSnippet endpoint="GET /plant/{plantId}" selector="request.path" />
37+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.path" />
3838
```
3939
will be rendered as:
4040
<br/>
41-
<h3>Path Parameters</h3>
42-
<img src="./path-parameters.png" alt="Get plant by ID" className="ml-0 dark:hidden" />
43-
<img src="./path-parameters-dark.png" alt="Get plant by ID" className="ml-0 hidden dark:block" />
41+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.path" />
4442
</Card>
4543
</Tab>
4644
<Tab title="Query">
@@ -49,11 +47,11 @@ to specify the path to the schema you want to reference. The available selectors
4947
<br/>
5048
The following markdown:
5149
```jsx
52-
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.query" />
50+
<EndpointSchemaSnippet endpoint="POST /discord/install" selector="request.query" />
5351
```
5452
will be rendered as:
5553
<br/>
56-
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.query" />
54+
<EndpointSchemaSnippet endpoint="POST /discord/install" selector="request.query" />
5755
</Card>
5856
</Tab>
5957
<Tab title="Body">
@@ -62,11 +60,11 @@ to specify the path to the schema you want to reference. The available selectors
6260
<br/>
6361
The following markdown:
6462
```jsx
65-
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.body" />
63+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.body" />
6664
```
6765
will be rendered as:
6866
<br/>
69-
<EndpointSchemaSnippet endpoint="POST /snippets/load" selector="request.body" />
67+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.body" />
7068
</Card>
7169
</Tab>
7270
</Tabs>
@@ -82,11 +80,11 @@ to specify the path to the schema you want to reference. The available selectors
8280

8381
The following markdown:
8482
```jsx
85-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response" />
83+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response" />
8684
```
8785
will be rendered as:
8886
<br/>
89-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response" />
87+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response" />
9088
</Card>
9189
</Tab>
9290
<Tab title="Body">
@@ -95,11 +93,11 @@ to specify the path to the schema you want to reference. The available selectors
9593
<br/>
9694
The following markdown:
9795
```jsx
98-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response.body" />
96+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />
9997
```
10098
will be rendered as:
10199
<br/>
102-
<EndpointSchemaSnippet endpoint="POST /snippets" selector="response.body" />
100+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />
103101
</Card>
104102
</Tab>
105103
</Tabs>
@@ -111,11 +109,11 @@ to specify the path to the schema you want to reference. The available selectors
111109
<br/>
112110
Passing no selector will render the entire schema. The following markdown:
113111
```jsx
114-
<EndpointSchemaSnippet endpoint="POST /snippets" />
112+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" />
115113
```
116114
will be rendered as:
117115
<br/>
118-
<EndpointSchemaSnippet endpoint="POST /snippets" />
116+
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" />
119117
</Card>
120118
</Tab>
121119
</Tabs>

0 commit comments

Comments
 (0)