+ {documentation.eyebrow} +
++ {documentation.title} +
++ {documentation.description} +
++ {copy.openApiKicker} +
+{copy.openApiTitle}
++ {copy.openApiDescription} +
+ + {copy.openApiAction} + + +-
+
- {copy.facts.version} +
- + {documentation.version} · {documentation.specVersion} + +
- {copy.facts.auth} +
- + {documentation.auth.title} + + {documentation.auth.description} + + +
- {copy.facts.format} +
- + + {documentation.format.title} + + + {documentation.format.description} + + +
- {copy.facts.baseUrl} +
- + {documentation.baseUrl} + +
+ 01 / {copy.quickstart} +
++ {copy.quickstart} +
++ {copy.quickstartDescription} +
+-
+ {documentation.quickstarts.map((step, index) => (
+
-
+ + + {String(index + 1).padStart(2, '0')} + ++++
{step.label}
++ {step.description} +
+++{step.command} +
+ ))}
+
+ 02 / {copy.conventions} +
++ {copy.conventions} +
++ {copy.conventionsDescription} +
+-
+ {documentation.conventions.map((convention) => (
+
- {convention.title} +
- + {convention.description} + +
+ 03 / {copy.schemaKicker} +
++ {copy.schemas} +
++ {copy.schemasDescription} +
+-
+ {documentation.schemaNotes.map((schema) => (
+
- {schema.title} +
-
+
{schema.description}
++ {copy.schemaShape} +
+{formatCode(schema.shape)} + {schema.example !== undefined && ( + <> ++ {copy.schemaExample} +
+{formatCode(schema.example)} + > + )} +
+
+ 04 / {copy.referenceKicker} +
++ {copy.endpoints} +
++ {copy.endpointsDescription} +
++ {operationCount} {operationCount === 1 ? copy.operation : copy.operations} +
++ {group.title} +
++ {group.description} +
+
+
+ {operation.method}
+
+
+ {operation.stability === 'stable' ? copy.stable : copy.beta}
+
+
+
+ {operation.path}
+
+
+ {operation.summary}
+
+
+
+
+
+ + {operation.description} +
+ ++ {copy.parameters} +
+ {operation.parameters.length === 0 ? ( ++ {copy.noParameters} +
+ ) : ( +| + {copy.name} + | ++ {copy.location} + | ++ {copy.type} + | ++ {copy.requirement} + | ++ {copy.description} + | ++ {copy.example} + | +
|---|---|---|---|---|---|
| + {parameter.name} + | ++ {parameter.location} + | ++ {parameter.type} + | ++ {parameter.required ? copy.required : copy.optional} + | ++ {parameter.description} + | ++ {parameter.example === undefined + ? null + : formatCode(parameter.example)} + | +
+ {copy.request} +
++ {copy.responses} +
+
+ {operation.responseShapeName}
+
+ + {response.description} +
+ {response.mediaType && ( + + {copy.mediaType}: {response.mediaType} + + )} ++ {copy.responseShape} +
++ {copy.responseExample} +
++ {copy.alternateRepresentation}: {alternate.mediaType} +
++ {copy.responseShape} +
++ {copy.responseExample} +
+