Skip to content

Apirequest clarification #23174

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

Merged
merged 2 commits into from
Jun 24, 2025
Merged

Apirequest clarification #23174

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e803208
[Style guide] Add explanation to apirequest param
kodster28 Jun 23, 2025
bc475e3
reword
kodster28 Jun 23, 2025
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
6 changes: 5 additions & 1 deletion src/content/docs/style-guide/components/api-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ styleGuide:

```mdx
import { APIRequest } from "~/components";

;
```

## Usage
Expand All @@ -22,7 +24,7 @@ import { APIRequest } from "~/components";
validation_default_mitigation_action: "block",
}}
code={{
mark: [5, "block"]
mark: [5, "block"],
}}
/>

Expand Down Expand Up @@ -112,6 +114,8 @@ The JSON payload to send.

If required properties are missing, the component will throw an error.

Functionally, [the `--json` option](https://everything.curl.dev/http/post/json.html) is equivalent to the `--data` option in cURL, but handles a few additional headers automatically.

### `form`

**type:** `Record<string, any>`
Expand Down