Class SchemaValidationMixin<Response, Parameters, RequestBody>

Type Parameters

Response = any
Parameters extends Record<string, any> | void = any
RequestBody = any

Index

Constructors

Properties

disableSchemaValidation? STRICT

Methods

buildHttpHeaders buildHttpOptions buildHttpParams buildHttpPathParams validateParameters validateRequestBody validateResponse validationError

Constructors

constructor

new SchemaValidationMixin<
    Response = any,
    Parameters extends void | Record<string, any> = any,
    RequestBody = any,
>(): SchemaValidationMixin<Response, Parameters, RequestBody>
Type Parameters
- Response = any
- Parameters extends void | Record<string, any> = any
- RequestBody = any
Returns SchemaValidationMixin<Response, Parameters, RequestBody>

Properties

`Protected` `Optional`disableSchemaValidation

disableSchemaValidation?: boolean

`Static`STRICT

STRICT: boolean = false

Methods

buildHttpHeaders

buildHttpHeaders(
operationParameters: ParameterObject[],
parameters?: Parameters,
): HttpHeaders
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: Parameters
Returns HttpHeaders
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:293

buildHttpOptions

buildHttpOptions(
    operation: OperationObjectWithMetadata,
    parameters?: Parameters,
    requestBody?: RequestBody,
    ignoreUndefined?: boolean,
): HttpRemoteMethodParameter
Converts open api parameters into the corresponding http options to create a http request. The transformation is guided by the openapi definition
Parameters
- operation: OperationObjectWithMetadata
- Optionalparameters: Parameters
- OptionalrequestBody: RequestBody
- ignoreUndefined: boolean = true
Returns HttpRemoteMethodParameter
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:367

buildHttpParams

buildHttpParams(
    operationParameters: ParameterObject[],
    parameters?: Parameters,
    ignoreUndefined?: boolean,
): HttpParams
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: Parameters
- ignoreUndefined: boolean = true
Returns HttpParams
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:244

buildHttpPathParams

buildHttpPathParams(
operationParameters: ParameterObject[],
parameters?: Parameters,
): Record<string, string>
Parameters
- operationParameters: ParameterObject[]
- Optionalparameters: Parameters
Returns Record<string, string>
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:333

`Protected`validateParameters

validateParameters(
    operation: OperationObjectWithMetadata,
    parameters?: Parameters,
    strict?: boolean,
): void
Protected
Validates the parameters against the schema specified in the operation object
Parameters
- operation: OperationObjectWithMetadata
- Optionalparameters: Parameters
- strict: boolean = false
Returns void
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:45

validateRequestBody

validateRequestBody(
    operation: OperationObjectWithMetadata,
    body?: RequestBody,
    strict?: boolean,
): void
Parameters
- operation: OperationObjectWithMetadata
- Optionalbody: RequestBody
- strict: boolean = false
Returns void
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:189

`Protected`validateResponse

validateResponse(
    operation: OperationObjectWithMetadata,
    response: SchemaValidationResponse<Response>,
    strict?: boolean,
): void
Protected
Validates the http response against the schema specified in the operation object
Parameters
- operation: OperationObjectWithMetadata
- response: SchemaValidationResponse<Response>
- strict: boolean = false
Returns void
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:122

validationError

validationError(
    message: string,
    strict: boolean,
    schema?: ReferenceObject | SchemaObject,
    value?: any,
): void
Parameters
- message: string
- strict: boolean
- Optionalschema: ReferenceObject | SchemaObject
- Optionalvalue: any
Returns void
- Defined in packages/angular/open-api/src/lib/schema-validation.mixin.ts:222