openapi

Documentation

Overview

Package openapi provides methods for using the OpenAPI schema for validation and defaulting.

Index

• func ApplyDefaults(opts options.JSONOptions, optSchema *apiextv1beta1.JSONSchemaProps) (options.JSONOptions, error)
• func ValidateOptions(opts options.JSONOptions, optSchema *apiextv1beta1.JSONSchemaProps) (*validate.Result, error)

Functions

func ApplyDefaults

func ApplyDefaults(opts options.JSONOptions, optSchema *apiextv1beta1.JSONSchemaProps) (options.JSONOptions, error)

ApplyDefaults adds defaults to options, using an OpenAPI schema.

func ValidateOptions

func ValidateOptions(opts options.JSONOptions, optSchema *apiextv1beta1.JSONSchemaProps) (*validate.Result, error)

ValidateOptions based on an OpenAPI schema. The returned result object contains helpers for manipulating the data and also getting feedback on errors, and so may be non-nil in the case of an error when the error is the result of openapi validation failure.