package
0.89.1
Repository: https://github.com/ddrake12/kin-openapi.git
Documentation: pkg.go.dev

# Functions

BoolPtr is a helper for defining OpenAPI schemas.
DefaultRefResolver is a default implementation of refNameResolver for the InternalizeRefs function.
DefineIPv4Format opts in ipv4 format validation on top of OAS 3 spec.
DefineIPv6Format opts in ipv6 format validation on top of OAS 3 spec.
DefineStringFormat Defines a new regexp pattern for a given format.
DefineStringFormatCallback adds a validation function for a specific schema format entry.
FailFast returns schema validation errors quicker.
Float64Ptr is a helper for defining OpenAPI schemas.
Int64Ptr is a helper for defining OpenAPI schemas.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewLoader returns an empty Loader.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RegisterArrayUniqueItemsChecker is used to register a customized function used to check if JSON array have unique items.
Uint64Ptr is a helper for defining OpenAPI schemas.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

FormatOfStringForUUIDOfRFC4122 is an optional predefined format for UUID v1-v5 as specified by RFC4122.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrOneOfConflict is the SchemaError Origin when data matches more than one oneOf schema.
ErrSchemaInputInf may be returned when validating a number.
ErrSchemaInputNaN may be returned when validating a number.
IdentifierRegExp verifies whether Component object key matches 'identifierPattern' pattern, according to OapiAPI v3.x.0.
SchemaErrorDetailsDisabled disables printing of details about schema errors.
SchemaFormatValidationDisabled disables validation of schema type formats.
SchemaStringFormats allows for validating strings format.

# Structs

CallbackRef represents either a Callback or a $ref to a Callback.
Components is specified by OpenAPI/Swagger standard version 3.0.
Contact is specified by OpenAPI/Swagger standard version 3.0.
Discriminator is specified by OpenAPI/Swagger standard version 3.0.
Encoding is specified by OpenAPI/Swagger 3.0 standard.
SchemaRef represents either a Schema or a $ref to a Schema.
Example is specified by OpenAPI/Swagger 3.0 standard.
ExampleRef represents either a Example or a $ref to a Example.
ExtensionProps provides support for OpenAPI extensions.
ExternalDocs is specified by OpenAPI/Swagger standard version 3.0.
No description provided by the author
Header is specified by OpenAPI/Swagger 3.0 standard.
HeaderRef represents either a Header or a $ref to a Header.
Info is specified by OpenAPI/Swagger standard version 3.0.
License is specified by OpenAPI/Swagger standard version 3.0.
Link is specified by OpenAPI/Swagger standard version 3.0.
LinkRef represents either a Link or a $ref to a Link.
Loader helps deserialize an OpenAPIv3 document.
MediaType is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
No description provided by the author
Operation represents "operation" specified by" OpenAPI/Swagger 3.0 standard.
Parameter is specified by OpenAPI/Swagger 3.0 standard.
ParameterRef represents either a Parameter or a $ref to a Parameter.
No description provided by the author
Ref is specified by OpenAPI/Swagger 3.0 standard.
RequestBody is specified by OpenAPI/Swagger 3.0 standard.
RequestBodyRef represents either a RequestBody or a $ref to a RequestBody.
Response is specified by OpenAPI/Swagger 3.0 standard.
ResponseRef represents either a Response or a $ref to a Response.
Schema is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
SchemaRef represents either a Schema or a $ref to a Schema.
No description provided by the author
SecuritySchemeRef represents either a SecurityScheme or a $ref to a SecurityScheme.
SerializationMethod describes a serialization method of HTTP request's parameters and body.
Server is specified by OpenAPI/Swagger standard version 3.0.
ServerVariable is specified by OpenAPI/Swagger standard version 3.0.
T is the root of an OpenAPI v3 document.
Tag is specified by OpenAPI/Swagger 3.0 standard.

# Type aliases

Callback is specified by OpenAPI/Swagger standard version 3.0.
No description provided by the author
Content is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
FormatCallback custom check on exotic formats.
No description provided by the author
No description provided by the author
MultiError is a collection of errors, intended for when multiple issues need to be reported upstream.
Parameters is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
Paths is specified by OpenAPI/Swagger standard version 3.0.
No description provided by the author
No description provided by the author
Responses is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
No description provided by the author
SchemaValidationOption describes options a user has when validating request / response bodies.
No description provided by the author
No description provided by the author
No description provided by the author
Servers is specified by OpenAPI/Swagger standard version 3.0.
SliceUniqueItemsChecker is an function used to check if an given slice have unique items.
Tags is specified by OpenAPI/Swagger 3.0 standard.