Skip to content

Commit a93851a

Browse files
authored
Update api-doc
Adding some titles to get the anchors to work and show up in the Navigation
1 parent 8a4257e commit a93851a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Diff for: src/app/v5/api/contacts/page.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,15 @@
7474
* [**/queues/:queueId/toggle** `POST`](#post-queuesqueueidtoggle)
7575
* [**/queues/:queueId/clear** `GET`](#get-queuesqueueidclear)
7676
* [**/queues/:queueId/clear** `POST`](#post-queuesqueueidclear)
77-
- [WebSocket Endpoint](#ws-endpoint)
77+
- [WebSocket Endpoint](#websocket-endpoint)
7878

79-
# Overview
79+
## Overview
8080
Firebot hosts a local API that developers can use to get data from Firebot or tell it to run effects.
8181
* The API is hosted on port **7472**. All endpoints have the root **http://localhost:7472/api/v1**
8282
* All responses are in JSON.
8383
* Don't forget that Firebot must be running for the API to be available.
8484

85-
# Endpoints
85+
## Rest Endpoints
8686

8787
## Authentication
8888

@@ -1622,7 +1622,7 @@ POST /queues/queue1/clear
16221622
"status": "removed"
16231623
}
16241624
```
1625-
# WS Endpoint
1625+
## WebSocket Endpoint
16261626
Firebot hosts a local Websocket API that developers can use to get data from Firebot.
16271627
* The API is hosted on port **7472**. All endpoints have the root **ws://localhost:7472/api/v1**
16281628
* All responses are in JSON.

0 commit comments

Comments
 (0)