Skip to content

Commit 1e05943

Browse files
committed
update docs
1 parent cc136d7 commit 1e05943

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

api-playground/asyncapi/playground.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Websockets Playground"
33
description: "Enable users to interact with your websockets"
44
---
55

6-
Autogenerating pages from your AsyncAPI spec will create pages for each channel that display message data that can be sent and received. In the API Playground for websockets, you can connect to websocket servers to send and receive messages.
6+
Autogenerating pages from your AsyncAPI schema will create pages for each channel that display message data that can be sent and received. In the API Playground for websockets, you can connect to websocket servers to send and receive messages.
77

88
![](https://picsum.photos/600/400)
99
(this should be a nice image of messages in the API playground)

api-playground/asyncapi/setup.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: "Reference AsyncAPI endpoints in your docs pages"
55

66
## Add an AsyncAPI specification file
77

8-
To begin to create pages for your websockets, make sure you have a valid AsyncAPI document in either JSON or YAML format that follows the [AsyncAPI specification](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Your document must follow AsyncAPI specification 3.0+.
9-
<Tip>To make sure your AsyncAPI spec is valid, you can paste it into the [AsyncAPI Studio](https://studio.asyncapi.com/)</Tip>
8+
To begin to create pages for your websockets, make sure you have a valid AsyncAPI schema document in either JSON or YAML format that follows the [AsyncAPI specification](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Your schema must follow AsyncAPI specification 3.0+.
9+
<Tip>To make sure your AsyncAPI schema is valid, you can paste it into the [AsyncAPI Studio](https://studio.asyncapi.com/)</Tip>
1010

1111
## Auto-populate websockets pages
1212

13-
You can add an `asyncapi` field to any tab or group in the navigation of your `docs.json`. This field can contain either the path to an AsyncAPI document in your docs repo, or the URL of a hosted AsyncAPI document. Mintlify will automatically generate a page for each AsyncAPI webhook channel.
13+
You can add an `asyncapi` field to any tab or group in the navigation of your `docs.json`. This field can contain either the path to an AsyncAPI schema document in your docs repo, the URL of a hosted AsyncAPI schema document, or an array of links to AsyncAPI schema documents. Mintlify will automatically generate a page for each AsyncAPI websocket channel.
1414

1515
**Examples with Tabs:**
1616
```json {5}
@@ -29,11 +29,11 @@ You can add an `asyncapi` field to any tab or group in the navigation of your `d
2929
"navigation": {
3030
"tabs": [
3131
{
32-
"tab": "API Reference",
32+
"tab": "AsyncAPI",
3333
"groups": [
3434
{
35-
"group": "Endpoints",
36-
"openapi": {
35+
"group": "Websockets",
36+
"asyncapi": {
3737
"source": "/path/to/asyncapi.json",
3838
"directory": "api-reference"
3939
}
@@ -46,4 +46,4 @@ You can add an `asyncapi` field to any tab or group in the navigation of your `d
4646

4747
<Note>The directory field is optional. If not specified, the files will be placed in the **api-reference** folder of the docs repo.</Note>
4848

49-
The metadata for the generated pages will contain the key `asyncapi` with a path to the original spec and the channel id so that the page can be generated per channel and display data about all websocket messages sent and received on that channel.
49+
The metadata for the generated pages will contain the key `asyncapi` with a path to the original spec and the channel id so that the page can be generated per channel and display data about all websocket messages sent and received on that channel. Learn more about interacting with websockets with generated AsyncAPI pages in the playground [here](api-playground/asyncapi/playground).

0 commit comments

Comments
 (0)