schema-components - v3.7.0
    Preparing search index...

    Interface ApiParametersProps<Doc, Path, Method>

    Props accepted by ApiParameters.

    interface ApiParametersProps<
        Doc = unknown,
        Path extends PathKeysOf<Doc> = PathKeysOf<Doc>,
        Method extends MethodKeysOf<Doc, Path> = MethodKeysOf<Doc, Path>,
    > {
        onDiagnostic?: DiagnosticSink;
        strict?: boolean;
        schema: Doc;
        path: Path;
        method: Method;
        meta?: SchemaMeta;
        overrides?: Doc extends Record<string, unknown>
            ? InferParameterOverrides<Doc, Path, Method>
            : Record<string, FieldOverride>;
        widgets?: WidgetMap;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    onDiagnostic?: DiagnosticSink
    strict?: boolean
    schema: Doc
    path: Path
    method: Method
    meta?: SchemaMeta
    overrides?: Doc extends Record<string, unknown>
        ? InferParameterOverrides<Doc, Path, Method>
        : Record<string, FieldOverride>
    widgets?: WidgetMap

    Instance-scoped widgets.