IOpenApiRegistry

Properties

registeredSchemas

registeredSchemas: IRegisteredApiSchema[]

Methods

register_api_schema()

register_api_schema(options): IRegisteredApiSchema

Parameters

Parameter	Type
options	IAdminForthEndpointOptions

Returns

IRegisteredApiSchema

---

registerApiSchema()

registerApiSchema(options): IRegisteredApiSchema

Parameters

Parameter	Type
options	IAdminForthEndpointOptions

Returns

IRegisteredApiSchema

---

renderOpenApiDocument()

renderOpenApiDocument(): object

Returns

object

---

validateRequestSchema()

validateRequestSchema(route, payload): IAdminForthApiValidationResult

Parameters

Parameter	Type
route	IRegisteredApiSchema
payload	any

Returns

IAdminForthApiValidationResult

---

validateResponseSchema()

validateResponseSchema(route, payload): IAdminForthApiValidationResult

Parameters

Parameter	Type
route	IRegisteredApiSchema
payload	any

Returns

IAdminForthApiValidationResult