package
0.0.0-20230123143103-d70969bef392
Repository: https://github.com/gozelle/openapi.git
Documentation: pkg.go.dev

# Functions

AllowExtraSiblingFields called as AllowExtraSiblingFields("description") makes Validate not return an error when said field appears next to a $ref.
BoolPtr is a helper for defining OpenAPI schemas.
DefaultRefResolver is a default implementation of refNameResolver for the InternalizeRefs function.
DefaultsSet executes the given callback (once) IFF schema validation set default values.
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.
DisableExamplesValidation disables all example schema validation.
DisablePatternValidation setting makes Validate not return an error when validating patterns that are not supported by the Go regexp engine.
DisableSchemaDefaultsValidation disables schemas' default field validation.
DisableSchemaFormatValidation does the opposite of EnableSchemaFormatValidation.
DisableSchemaPatternValidation makes Validate not return an error when validating patterns that are not supported by the Go regexp engine.
EnableExamplesValidation does the opposite of DisableExamplesValidation.
EnableFormatValidation setting makes Validate not return an error when validating documents that mention schema formats that are not defined by the OpenAPIv3 specification.
EnableSchemaDefaultsValidation does the opposite of DisableSchemaDefaultsValidation.
EnableSchemaFormatValidation makes Validate not return an error when validating documents that mention schema formats that are not defined by the OpenAPIv3 specification.
EnableSchemaPatternValidation does the opposite of DisableSchemaPatternValidation.
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
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
NewSchemaRef simply builds a SchemaRef.
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
ReadFromFile is a ReadFromURIFunc which reads local file URIs.
ReadFromHTTP returns a ReadFromURIFunc which uses the given http.Client to read the contents from a remote HTTP URI.
ReadFromURIs returns a ReadFromURIFunc which tries to read a URI using the given reader functions, in the same order.
RegisterArrayUniqueItemsChecker is used to register a customized function used to check if JSON array have unique items.
SetSchemaErrorMessageCustomizer allows to override the schema error message.
Uint64Ptr is a helper for defining OpenAPI schemas.
URIMapCache returns a ReadFromURIFunc that caches the contents read from URI locations in a simple map.
No description provided by the author
No description provided by the author
No description provided by the author
WithValidationOptions allows adding validation options to a context object that can be used when validationg any OpenAPI type.

# Constants

FormatOfStringForEmail pattern catches only some suspiciously wrong-looking email addresses.
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

No description provided by the author
No description provided by the author
DefaultReadFromURI returns a caching ReadFromURIFunc which can read remote HTTP URIs and local file URIs.
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.
ErrURINotSupported indicates the ReadFromURIFunc does not know how to handle a given URI.
IdentifierRegExp verifies whether Component object key matches 'identifierPattern' pattern, according to OapiAPI v3.x.0.
SchemaErrorDetailsDisabled disables printing of details about schema errors.
SchemaStringFormats allows for validating string formats.

# Structs

No description provided by the author
CallbackRef represents either a Callback or a $ref to a Callback.
Components is specified by OpenAPI/Swagger standard version 3.
Contact is specified by OpenAPI/Swagger standard version 3.
Discriminator is specified by OpenAPI/Swagger standard version 3.
Encoding is specified by OpenAPI/Swagger 3.0 standard.
Example is specified by OpenAPI/Swagger 3.0 standard.
ExampleRef represents either a Example or a $ref to a Example.
ExternalDocs is specified by OpenAPI/Swagger standard version 3.
Format represents a format validator registered by either DefineStringFormat or DefineStringFormatCallback.
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.
License is specified by OpenAPI/Swagger standard version 3.
Link is specified by OpenAPI/Swagger standard version 3.
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.
OAuthFlow is specified by OpenAPI/Swagger standard version 3.
OAuthFlows is specified by OpenAPI/Swagger standard version 3.
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.
PathItem is specified by OpenAPI/Swagger standard version 3.
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.
SecurityScheme is specified by OpenAPI/Swagger standard version 3.
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.
ServerVariable is specified by OpenAPI/Swagger standard version 3.
T is the root of an OpenAPI v3 document See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-object.
Tag is specified by OpenAPI/Swagger 3.0 standard.
ValidationOptions provides configuration for validating OpenAPI documents.
XML is specified by OpenAPI/Swagger standard version 3.

# Type aliases

Callback is specified by OpenAPI/Swagger standard version 3.
No description provided by the author
Content is specified by OpenAPI/Swagger 3.0 standard.
No description provided by the author
FormatCallback performs custom checks 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.
ReadFromURIFunc defines a function which reads the contents of a resource located at a URI.
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.
SecurityRequirement is specified by OpenAPI/Swagger standard version 3.
No description provided by the author
No description provided by the author
Servers is specified by OpenAPI/Swagger standard version 3.
SliceUniqueItemsChecker is an function used to check if an given slice have unique items.
Tags is specified by OpenAPI/Swagger 3.0 standard.
ValidationOption allows the modification of how the OpenAPI document is validated.