Skip to content

Commit b704e64

Browse files
authored
Apirequest clarification (#23174)
* [Style guide] Add explanation to apirequest param * reword
1 parent 0ee0fbb commit b704e64

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/content/docs/style-guide/components/api-request.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ styleGuide:
88

99
```mdx
1010
import { APIRequest } from "~/components";
11+
12+
;
1113
```
1214

1315
## Usage
@@ -22,7 +24,7 @@ import { APIRequest } from "~/components";
2224
validation_default_mitigation_action: "block",
2325
}}
2426
code={{
25-
mark: [5, "block"]
27+
mark: [5, "block"],
2628
}}
2729
/>
2830

@@ -112,6 +114,8 @@ The JSON payload to send.
112114

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

117+
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.
118+
115119
### `form`
116120

117121
**type:** `Record<string, any>`

0 commit comments

Comments
 (0)