ApiSchemaParamDetails() — supabase Function Reference

Architecture documentation for the ApiSchemaParamDetails() function in Reference.ui.tsx from the supabase codebase.

Function tsx DocumentationSystem ReferenceGen calls 1

Entity Profile

DocumentationSystem→ ReferenceGen→ ApiSchemaParamDetails() — supabase Function Reference

Dependency Diagram

graph TD
  c3e497ec_f856_95f0_0bc9_021b36406772["ApiSchemaParamDetails()"]
  ddd25313_39f7_44ef_a55f_cf32b776fdab["getTypeDisplayFromSchema()"]
  c3e497ec_f856_95f0_0bc9_021b36406772 -->|calls| ddd25313_39f7_44ef_a55f_cf32b776fdab
  style c3e497ec_f856_95f0_0bc9_021b36406772 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/features/docs/Reference.ui.tsx lines 336–361

export function ApiSchemaParamDetails({ param }: { param: IApiEndPoint['parameters'][number] }) {
  return (
    <li className="border-t last-of-type:border-b py-5 flex flex-col gap-3">
      <div className="flex flex-wrap items-baseline gap-3">
        <span className="font-mono text-sm font-medium text-foreground break-all">
          {param.name}
        </span>
        {param.required ? (
          <Badge variant="warning">Required</Badge>
        ) : (
          <Badge variant="default">Optional</Badge>
        )}
        {param.schema?.deprecated && <span className="text-xs text-warning">Deprecated</span>}
        {param.schema && (
          <span className="text-xs text-foreground-muted">
            {getTypeDisplayFromSchema(param.schema)?.displayName ?? ''}
          </span>
        )}
      </div>
      {param.description && (
        <ReactMarkdown className="prose break-words text-sm">{param.description}</ReactMarkdown>
      )}
      {param.schema && <ApiSchemaParamSubdetails schema={param.schema} />}
    </li>
  )
}