queryschema

Documentation

Index

• Constants
• func AddQueriesToOpenAPI(options OASQueryOptions) error
• func RegisterQueryTypes(queryTypes *query.QueryTypeDefinitionList, storage map[string]rest.Storage) error
• type OASQueryOptions

Constants

const QueryRequestSchemaKey = "QueryRequestSchema"

Functions

func AddQueriesToOpenAPI

func AddQueriesToOpenAPI(options OASQueryOptions) error

func RegisterQueryTypes

func RegisterQueryTypes(queryTypes *query.QueryTypeDefinitionList, storage map[string]rest.Storage) error

Types

type OASQueryOptions

type OASQueryOptions struct {
	Swagger    *spec3.OpenAPI
	PluginJSON *plugins.JSONData
	QueryTypes *query.QueryTypeDefinitionList

	Root             string
	QueryPath        string // eg "namespaces/{namespace}/query/{name}"
	QueryDescription string
	QueryExamples    map[string]*spec3.Example
}