Interface ApiResponseField

Describes a field included in an API response, optionally including the field path and a description.

interface ApiResponseField {
    description?: string;
    location: ApiResponseParameterLocation;
    path?: string;
}

Properties

description?: string

An optional description of the field's content or purpose.

The location of the field in the API response (e.g., header, body).

path?: string

The path to the field within the response structure, if applicable.