Prefix API key header in interactive docs

docusaurus.config.ts

@@ -168,6 +168,7 @@ const config: Config = {
         },
       },
     ],
+    "@docusaurus/theme-live-codeblock",
     [
       "@signalwire/docusaurus-plugin-llms-txt",
       {

package.json

@@ -7,7 +7,7 @@
     "start": "run-p build:jobs-api-ref && dotenv -e .env -e .env.local node_modules/.bin/docusaurus start",
     "build": "run-p build:jobs-api-ref && dotenv -e .env -e .env.local node_modules/.bin/docusaurus build",
     "build:jobs-spec": "tsx scripts/generate-batch-spec.ts",
-    "build:jobs-api-ref": "rimraf docs/api-ref/jobs && npm run build:jobs-spec && docusaurus gen-api-docs jobs",
+    "build:jobs-api-ref": "rm -rf docs/api-ref/batch && npm run build:jobs-spec && docusaurus gen-api-docs jobs",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
@@ -23,8 +23,10 @@
   "dependencies": {
     "@docusaurus/core": "^3.8.1",
     "@docusaurus/preset-classic": "^3.8.1",
+    "@docusaurus/theme-live-codeblock": "^3.8.1",
     "@docusaurus/theme-mermaid": "^3.8.1",
     "@mdx-js/react": "^3.0.0",
+    "@radix-ui/react-compose-refs": "^1.1.2",
     "@radix-ui/themes": "^3.2.1",
     "@signalwire/docusaurus-plugin-llms-txt": "^1.2.1",
     "asyncapi-schema-loader": "^0.0.1",
@@ -62,11 +64,7 @@
     "postman-code-generators": "1.10.1"
   },
   "browserslist": {
-    "production": [
-      ">0.5%",
-      "not dead",
-      "not op_mini all"
-    ],
+    "production": [">0.5%", "not dead", "not op_mini all"],
     "development": [
       "last 3 chrome version",
       "last 3 firefox version",

scripts/redirects/sync-redirects.ts

@@ -3,8 +3,8 @@ import { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 import vercelJSON from "../../vercel.json" with { type: "json" };
 import { normalizePath } from "./check-redirects";
-import redirects from "./redirects.json" with { type: "json" };
 import oldRedirects from "./old-redirects.json" with { type: "json" };
+import redirects from "./redirects.json" with { type: "json" };
 import superOldRedirects from "./super-old-redirects.json" with {
   type: "json",
 };

spec/batch.yaml

@@ -22,6 +22,8 @@ parameters:
     name: Authorization
     in: header
     description: Customer API token
+    pattern: "^Bearer .+$"
+    x-docusaurus-example-prefix: "Bearer "
     required: true
     type: string
   EARTag:
@@ -37,12 +39,20 @@ paths:
       - $ref: "#/parameters/EARTag"
     post:
       summary: Create a new job
+      description: |
+        Create and configure a new job.
+
+        :::tip
+        The quickest way to create a transcription job is to use the [Speechmatics Portal](https://portal.speechmatics.com/jobs/create/batch).
+        :::
       consumes:
         - multipart/form-data
       parameters:
         - name: config
           in: formData
           type: string
+          x-docusaurus-example-element: textarea
+          x-docusaurus-example-value: "{}"
           description: >-
             JSON containing a [`JobConfig`](/speech-to-text/batch/input#jobconfig-schema) model indicating the type and parameters for the recognition job.
           required: true

src/css/custom.css

@@ -20,4 +20,4 @@
 .radix-themes .openapi-explorer__form-item-input {
   background-color: var(--gray-1);
   border-color: var(--gray-4);
-}
+}

src/css/infima-overrides.css

@@ -130,6 +130,7 @@ html[data-theme="dark"] {
   --ifm-color-primary-lightest: var(--accent-7);
 
   --color-background: var(--gray-3);
+  --segmented-control-indicator-background-color: var(--color-panel);
   --ifm-background-color: var(--gray-3);
   --base-card-surface-hover-box-shadow: 0 0 0 1px
     color-mix(in oklab, var(--gray-a8), var(--gray-8) 25%);

src/css/markdown.css

@@ -1,3 +1,3 @@
 .rt-CalloutText {
   --ifm-paragraph-margin-bottom: 0;
-}
+}