package
0.0.0-20250304201544-e5f78fe3ede9
Repository: https://github.com/kubernetes/kube-openapi.git
Documentation: pkg.go.dev
# Functions
ArrayProperty creates an array property.
BooleanProperty creates a boolean property.
BoolProperty creates a boolean property.
CharProperty creates a string property.
ComposedSchema creates a schema with allOf.
DateProperty creates a date property.
DateTimeProperty creates a date time property.
Float32Property creates a float32/float property.
Float64Property creates a float64/double property.
Int16Property creates an int16 property.
Int32Property creates an int32 property.
Int64Property creates an int64 property.
Int8Property creates an int8 property.
MapProperty creates a map property.
MustCreateRef creates a ref object but panics when refURI is invalid.
NewRef creates a new instance of a ref object returns an error when the reference uri is an invalid uri.
NewResponse creates a new response instance.
RefProperty creates a ref property.
RefSchema creates a ref property.
ResponseRef creates a response as a json reference.
StrFmtProperty creates a property for the named string format.
StringProperty creates a string property.
# Structs
CommonValidations describe common JSON-schema validations.
ContactInfo contact information for the exposed API.
ExternalDocumentation allows referencing an external resource for extended documentation.
Header describes a header for a response of the API
For more information: http://goo.gl/8us55a#headerObject.
HeaderProps describes a response header.
Info object provides metadata about the API.
InfoProps the properties for an info definition.
Items a limited subset of JSON-Schema's items object.
License information for the exposed API.
Operation describes a single API operation on a path.
OperationProps describes an operation
NOTES: - schemes, when present must be from [http, https, ws, wss]: see validate - Security is handled as a special case: see MarshalJSON function.
Parameter a unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn).
ParamProps describes the specific attributes of an operation parameter
NOTE: - Schema is defined when "in" == "body": see validate - AllowEmptyValue is allowed where "in" == "query" || "formData".
PathItem describes the operations available on a single path.
PathItemProps the path item specific properties.
Paths holds the relative paths to the individual endpoints.
Ref represents a json reference that is potentially resolved.
Refable is a struct for things that accept a $ref property.
Response describes a single response from an API Operation.
ResponseProps properties specific to a response.
Responses is a container for the expected responses of an operation.
ResponsesProps describes all responses for an operation.
Schema the schema object allows the definition of input and output data types.
SchemaOrArray represents a value that can either be a Schema or an array of Schema.
SchemaOrBool represents a schema or boolean value, is biased towards true for the boolean property.
SchemaOrStringArray represents a schema or a string array.
SchemaProps describes a JSON schema (draft 4).
SecurityScheme allows the definition of a security scheme that can be used by the operations.
SecuritySchemeProps describes a swagger security scheme in the securityDefinitions section.
SimpleSchema describe swagger simple schemas for parameters and headers.
Swagger this is the root document object for the API specification.
SwaggerProps captures the top-level properties of an Api specification
NOTE: validation rules - the scheme, when present must be from [http, https, ws, wss] - BasePath must start with a leading "/" - Paths is required.
SwaggerSchemaProps are additional properties supported by swagger schemas, but not JSON-schema (draft 4).
Tag allows adding meta data to a single tag that is used by the [Operation Object](http://goo.gl/8us55a#operationObject).
TagProps describe a tag entry in the top level tags section of a swagger spec.
VendorExtensible composition block.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Interfaces.
No description provided by the author
# Type aliases
Definitions contains the models explicitly defined in this spec An object to hold data types that can be consumed and produced by operations.
Dependencies represent a dependencies property.
Extensions vendor specific extensions.
SchemaURL represents a schema url.
SecurityDefinitions a declaration of the security schemes available to be used in the specification.
StringOrArray represents a value that can either be a string or an array of strings.