Skip to content

chore: autofix docs formatting #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: autofix docs formatting #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/scnx-api/reference/message-schema-v4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,9 +386,9 @@ content.
```

| `scnx_action` field | Type | Description |
| ------------------- | ------ | --------------------------------------------------------------------------------------------------------- |
| `type` | string | `"flowButton"` |
| `flowId` | string | ID of the flow to start when clicked. |
| ------------------- | ------ | ---------------------------------------------------------------------------------------------------------- |
| `type` | string | `"flowButton"` |
| `flowId` | string | ID of the flow to start when clicked. |
| `state` | string | Optional. A short state string handed to the flow (readable from the button's trigger). Max 80 characters. |

:::note Reserved
Expand All @@ -400,12 +400,12 @@ reserved and ships with the flow executor milestone. Do not emit it yet.

At send time SCNX derives each flow component's Discord `custom_id` from its `scnx_action`:

| Action | Generated `custom_id` |
| ----------------------------------- | ------------------------------ |
| `flowButton` without `state` | `ccv3:<flowId>` |
| `flowButton` with `state` `s` | `ccv3:<flowId>:<s>` |
| a raw custom id with no flow target | `<s>` verbatim |
| `flowWaitButton` (reserved) | `ccv3w:<executionId>:<id>` |
| Action | Generated `custom_id` |
| ----------------------------------- | -------------------------- |
| `flowButton` without `state` | `ccv3:<flowId>` |
| `flowButton` with `state` `s` | `ccv3:<flowId>:<s>` |
| a raw custom id with no flow target | `<s>` verbatim |
| `flowWaitButton` (reserved) | `ccv3w:<executionId>:<id>` |

#### Button Fields {#button-fields}

Expand Down Expand Up @@ -512,20 +512,20 @@ Starts a flow when an option is chosen. **Guild-specific** - not recommended for
}
```

| `scnx_action` field | Type | Description |
| `scnx_action` field | Type | Description |
| ------------------- | ------ | ------------------------------------------------- |
| `type` | string | `"flowElement"` |
| `flowId` | string | ID of the flow to start when an option is chosen. |

#### String Select Fields {#string-select-fields}

| Field | Type | Required | Description |
| ------------- | ------- | -------- | --------------------------------------------------------------------------------------- |
| `placeholder` | string | No | Text shown when nothing is selected. Max 150 characters. |
| `min_values` | integer | No | Minimum selections required (Self-Role only). Default: `0`. |
| `max_values` | integer | No | Maximum selections allowed (Self-Role only). Default: number of options, max: `25`. |
| Field | Type | Required | Description |
| ------------- | ------- | -------- | -------------------------------------------------------------------------------------------------- |
| `placeholder` | string | No | Text shown when nothing is selected. Max 150 characters. |
| `min_values` | integer | No | Minimum selections required (Self-Role only). Default: `0`. |
| `max_values` | integer | No | Maximum selections allowed (Self-Role only). Default: number of options, max: `25`. |
| `scnx_action` | object | Yes | `{ "type": "roleElement" }`, `{ "type": "customCommandElement" }`, or `{ "type": "flowElement" }`. |
| `options` | array | Yes | 1–25 options. |
| `options` | array | Yes | 1–25 options. |

#### Option Fields {#option-fields}

Expand Down