Function: ApiSchema()

function ApiSchema(props: Readonly<{
  method: ApiSchemaMethod;
  path: string;
  description?: string;
  parameters?: Readonly<{
     name: string;
     type: string;
     required?: boolean;
     description?: string;
  }>[];
  requestBody?: Readonly<{
     name: string;
     type: string;
     required?: boolean;
     description?: string;
  }>[];
  responseBody?: Readonly<{
     name: string;
     type: string;
     required?: boolean;
     description?: string;
  }>[];
  className?: string;
}> & RefAttributes<HTMLDivElement>): Block;

Defined in: src/renderer/blocks/index.ts:2625

Experimental

ApiSchema — REST endpoint shape (method/path/parameters/body) — renamed from upstream SchemaDisplay.

Parameters

Parameter

Type

props

Readonly<{ method: ApiSchemaMethod; path: string; description?: string; parameters?: Readonly<{ name: string; type: string; required?: boolean; description?: string; }>[]; requestBody?: Readonly<{ name: string; type: string; required?: boolean; description?: string; }>[]; responseBody?: Readonly<{ name: string; type: string; required?: boolean; description?: string; }>[]; className?: string; }> & RefAttributes<HTMLDivElement>

Returns

Block