diff --git a/src/content/docs/style-guide/components/api-request.mdx b/src/content/docs/style-guide/components/api-request.mdx index 16b566e08358838..60db7ada864f008 100644 --- a/src/content/docs/style-guide/components/api-request.mdx +++ b/src/content/docs/style-guide/components/api-request.mdx @@ -8,6 +8,8 @@ styleGuide: ```mdx import { APIRequest } from "~/components"; + +; ``` ## Usage @@ -22,7 +24,7 @@ import { APIRequest } from "~/components"; validation_default_mitigation_action: "block", }} code={{ - mark: [5, "block"] + mark: [5, "block"], }} /> @@ -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`