Skip to content

Commit 574fca7

Browse files
authored
chore: Fix examples for Endpoint Request/Response Snippet pages (#1399)
1 parent 8f35197 commit 574fca7

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ description: 'Reference an endpoint request from your API Reference'
44
---
55

66
The `EndpointRequestSnippet` component is used to reference an endpoint request from
7-
your API Reference. Below is an example of referencing the request for the `POST /snippets` endpoint.
7+
your API Reference. Below is an example of referencing the request for the `POST /chat/{domain}` endpoint.
88

99
<CodeBlock title="Markdown">
1010
```jsx
11-
<EndpointRequestSnippet endpoint="POST /snippets" />
11+
<EndpointRequestSnippet endpoint="POST /chat/{domain}" />
1212
```
1313
</CodeBlock>
1414

1515
will be rendered as:
1616

17-
<EndpointRequestSnippet endpoint="POST /snippets" />
17+
<EndpointRequestSnippet endpoint="POST /chat/{domain}" />
1818

1919
### Reference particular examples
2020

@@ -28,7 +28,7 @@ to the name of the example. See the steps below:
2828

2929
<AccordionGroup>
3030
<Accordion title="OpenAPI">
31-
```yaml {12}
31+
```yaml openapi.yml {12}
3232
paths:
3333
/pet:
3434
put:
@@ -47,7 +47,7 @@ to the name of the example. See the steps below:
4747
```
4848
</Accordion>
4949
<Accordion title="Fern Definition">
50-
```yaml {11}
50+
```yaml pets.yml {11}
5151
service:
5252
auth: true
5353
base-path: ""
@@ -71,7 +71,7 @@ to the name of the example. See the steps below:
7171
In the API Definition, the example had a name `ExampleWithMarkley`. You can reference
7272
the example directly:
7373

74-
```jsx {3}
74+
```jsx Markdown {3}
7575
<EndpointRequestSnippet
7676
endpoint="PUT /pet"
7777
example="ExampleWithMarkley"

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ description: 'Reference an endpoint response from your API Reference'
55

66
The `EndpointResponseSnippet` component is used to reference an endpoint
77
response from your API Reference. Below is an example of referencing the
8-
response for the `POST /snippets` endpoint.
8+
response for the `POST /chat/{domain}` endpoint.
99

1010
<CodeBlock title="Markdown">
1111
```jsx
12-
<EndpointResponseSnippet endpoint='POST /snippets' />
12+
<EndpointResponseSnippet endpoint='POST /chat/{domain}' />
1313
```
1414
</CodeBlock>
1515

1616
will be rendered as
1717

18-
<EndpointResponseSnippet endpoint='POST /snippets' />
18+
<EndpointResponseSnippet endpoint='POST /chat/{domain}' />
1919

2020

2121
### Reference particular examples
@@ -30,7 +30,7 @@ to the name of the example. See the steps below:
3030

3131
<AccordionGroup>
3232
<Accordion title="OpenAPI">
33-
```yaml {13}
33+
```yaml openapi.yml {13}
3434
paths:
3535
/pet/{petId}:
3636
put:
@@ -51,7 +51,7 @@ to the name of the example. See the steps below:
5151
```
5252
</Accordion>
5353
<Accordion title="Fern Definition">
54-
```yaml {11}
54+
```yaml pets.yml {11}
5555
service:
5656
auth: true
5757
base-path: ""
@@ -77,7 +77,7 @@ to the name of the example. See the steps below:
7777
In the API Definition, the example had a name `ExampleWithMarkley`. You can reference
7878
the example directly:
7979

80-
```jsx {3}
80+
```jsx Markdown {3}
8181
<EndpointResponseSnippet
8282
endpoint="GET /pet/{petId}"
8383
example="ExampleWithMarkley"

0 commit comments

Comments
 (0)