Skip to content

describeItems

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/openapi/param-source-inference.ts

Locate the array of records in a response schema and describe how to read it. Returns null when the response is not a list of objects — a scalar or a single record has no candidate values to offer.

Signature

ts
function describeItems(schema: SchemaLike | undefined, components: Record<string, SchemaLike>): { itemsPath: string; item: SchemaLike } | null

Parameters

NameType
schema`SchemaLike
componentsRecord<string, SchemaLike>

Returns: { itemsPath: string; item: SchemaLike } | null

Was this page helpful?

Download as PDF