Skip to content

Commit

Permalink
docs: fix /api/requests links
Browse files Browse the repository at this point in the history
  • Loading branch information
Whipstickgostop committed Oct 4, 2024
1 parent 4fba57a commit 28152b7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions apps/docs/content/2.guide/0.actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: 'Fetch your actions list and execute specific actions on your Strea

There are multiple requests that allow you to fetch various data from your Streamer.bot instance.

::callout{icon=i-mdi-bookmark to=/api/methods}
Explore the [Methods API Reference](/api/methods) which documents all requests and their responses.
::callout{icon=i-mdi-bookmark to=/api/requests}
Explore the [Methods API Reference](/api/requests) which documents all requests and their responses.
::

## Fetching Actions

You can fetch a list of all actions on your Streamer.bot instance with the [getActions](/api/methods#getactions) method.
You can fetch a list of all actions on your Streamer.bot instance with the [getActions](/api/requests#getactions) method.

```ts [Request]
const response = await client.getActions();
Expand Down Expand Up @@ -43,9 +43,9 @@ const response = await client.getActions();

## Executing Actions

You can execute an action on your Streamer.bot instance with the [doAction](/api/methods#doaction) method.
You can execute an action on your Streamer.bot instance with the [doAction](/api/requests#doaction) method.

The first parameter accepts the `actionId` which can be acquired from your Streamer.bot application, or programmatically using the [getActions](/api/methods#getactions) method outlined above.
The first parameter accepts the `actionId` which can be acquired from your Streamer.bot application, or programmatically using the [getActions](/api/requests#getactions) method outlined above.

```ts [Basic Example]
// Execute an action with actionId "9c6203fd-363f-4834-983e-b10423c568ea"
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/3.api/0.config.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ If you've modified your `WebSocket Server` settings in Streamer.bot, make sure t
::field{name=onData type="(data: Object) => void"}
Global callback when the client receives JSON data from the `WebSocket Server`

Data could be any [Event](/api/events) payload or [Method](/api/methods) response.
Data could be any [Event](/api/events) payload or [Method](/api/requests) response.

```ts
const client = new StreamerbotClient({
Expand Down
1 change: 1 addition & 0 deletions apps/docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export default defineNuxtConfig({
'/get-started': { redirect: { to: '/get-started/installation', statusCode: 301 } },
'/guide': { redirect: { to: '/guide/actions', statusCode: 301 } },
'/api': { redirect: { to: '/api/config', statusCode: 301 } },
'/api/methods': { redirect: { to: '/api/requests', statusCode: 301 } },
},
prerender: {
crawlLinks: true,
Expand Down

0 comments on commit 28152b7

Please sign in to comment.