...

Package openapiconfig

import "github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor/openapiconfig"
Overview
Index

Overview ▾

Index ▾

Variables
type OpenAPIConfig
    func (*OpenAPIConfig) Descriptor() ([]byte, []int)
    func (x *OpenAPIConfig) GetOpenapiOptions() *OpenAPIOptions
    func (*OpenAPIConfig) ProtoMessage()
    func (x *OpenAPIConfig) ProtoReflect() protoreflect.Message
    func (x *OpenAPIConfig) Reset()
    func (x *OpenAPIConfig) String() string
type OpenAPIFieldOption
    func (*OpenAPIFieldOption) Descriptor() ([]byte, []int)
    func (x *OpenAPIFieldOption) GetField() string
    func (x *OpenAPIFieldOption) GetOption() *options.JSONSchema
    func (*OpenAPIFieldOption) ProtoMessage()
    func (x *OpenAPIFieldOption) ProtoReflect() protoreflect.Message
    func (x *OpenAPIFieldOption) Reset()
    func (x *OpenAPIFieldOption) String() string
type OpenAPIFileOption
    func (*OpenAPIFileOption) Descriptor() ([]byte, []int)
    func (x *OpenAPIFileOption) GetFile() string
    func (x *OpenAPIFileOption) GetOption() *options.Swagger
    func (*OpenAPIFileOption) ProtoMessage()
    func (x *OpenAPIFileOption) ProtoReflect() protoreflect.Message
    func (x *OpenAPIFileOption) Reset()
    func (x *OpenAPIFileOption) String() string
type OpenAPIMessageOption
    func (*OpenAPIMessageOption) Descriptor() ([]byte, []int)
    func (x *OpenAPIMessageOption) GetMessage() string
    func (x *OpenAPIMessageOption) GetOption() *options.Schema
    func (*OpenAPIMessageOption) ProtoMessage()
    func (x *OpenAPIMessageOption) ProtoReflect() protoreflect.Message
    func (x *OpenAPIMessageOption) Reset()
    func (x *OpenAPIMessageOption) String() string
type OpenAPIMethodOption
    func (*OpenAPIMethodOption) Descriptor() ([]byte, []int)
    func (x *OpenAPIMethodOption) GetMethod() string
    func (x *OpenAPIMethodOption) GetOption() *options.Operation
    func (*OpenAPIMethodOption) ProtoMessage()
    func (x *OpenAPIMethodOption) ProtoReflect() protoreflect.Message
    func (x *OpenAPIMethodOption) Reset()
    func (x *OpenAPIMethodOption) String() string
type OpenAPIOptions
    func (*OpenAPIOptions) Descriptor() ([]byte, []int)
    func (x *OpenAPIOptions) GetField() []*OpenAPIFieldOption
    func (x *OpenAPIOptions) GetFile() []*OpenAPIFileOption
    func (x *OpenAPIOptions) GetMessage() []*OpenAPIMessageOption
    func (x *OpenAPIOptions) GetMethod() []*OpenAPIMethodOption
    func (x *OpenAPIOptions) GetService() []*OpenAPIServiceOption
    func (*OpenAPIOptions) ProtoMessage()
    func (x *OpenAPIOptions) ProtoReflect() protoreflect.Message
    func (x *OpenAPIOptions) Reset()
    func (x *OpenAPIOptions) String() string
type OpenAPIServiceOption
    func (*OpenAPIServiceOption) Descriptor() ([]byte, []int)
    func (x *OpenAPIServiceOption) GetOption() *options.Tag
    func (x *OpenAPIServiceOption) GetService() string
    func (*OpenAPIServiceOption) ProtoMessage()
    func (x *OpenAPIServiceOption) ProtoReflect() protoreflect.Message
    func (x *OpenAPIServiceOption) Reset()
    func (x *OpenAPIServiceOption) String() string

Package files

openapiconfig.pb.go

Variables

var File_internal_descriptor_openapiconfig_openapiconfig_proto protoreflect.FileDescriptor

type OpenAPIConfig

OpenAPIConfig represents a set of OpenAPI options

type OpenAPIConfig struct {
    OpenapiOptions *OpenAPIOptions `protobuf:"bytes,1,opt,name=openapi_options,json=openapiOptions,proto3" json:"openapi_options,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIConfig) Descriptor

func (*OpenAPIConfig) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIConfig.ProtoReflect.Descriptor instead.

func (*OpenAPIConfig) GetOpenapiOptions

func (x *OpenAPIConfig) GetOpenapiOptions() *OpenAPIOptions

func (*OpenAPIConfig) ProtoMessage

func (*OpenAPIConfig) ProtoMessage()

func (*OpenAPIConfig) ProtoReflect

func (x *OpenAPIConfig) ProtoReflect() protoreflect.Message

func (*OpenAPIConfig) Reset

func (x *OpenAPIConfig) Reset()

func (*OpenAPIConfig) String

func (x *OpenAPIConfig) String() string

type OpenAPIFieldOption

OpenAPIFieldOption represents OpenAPI options on a field

type OpenAPIFieldOption struct {
    Field  string              `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
    Option *options.JSONSchema `protobuf:"bytes,2,opt,name=option,proto3" json:"option,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIFieldOption) Descriptor

func (*OpenAPIFieldOption) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIFieldOption.ProtoReflect.Descriptor instead.

func (*OpenAPIFieldOption) GetField

func (x *OpenAPIFieldOption) GetField() string

func (*OpenAPIFieldOption) GetOption

func (x *OpenAPIFieldOption) GetOption() *options.JSONSchema

func (*OpenAPIFieldOption) ProtoMessage

func (*OpenAPIFieldOption) ProtoMessage()

func (*OpenAPIFieldOption) ProtoReflect

func (x *OpenAPIFieldOption) ProtoReflect() protoreflect.Message

func (*OpenAPIFieldOption) Reset

func (x *OpenAPIFieldOption) Reset()

func (*OpenAPIFieldOption) String

func (x *OpenAPIFieldOption) String() string

type OpenAPIFileOption

OpenAPIFileOption represents OpenAPI options on a file

type OpenAPIFileOption struct {
    File   string           `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"`
    Option *options.Swagger `protobuf:"bytes,2,opt,name=option,proto3" json:"option,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIFileOption) Descriptor

func (*OpenAPIFileOption) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIFileOption.ProtoReflect.Descriptor instead.

func (*OpenAPIFileOption) GetFile

func (x *OpenAPIFileOption) GetFile() string

func (*OpenAPIFileOption) GetOption

func (x *OpenAPIFileOption) GetOption() *options.Swagger

func (*OpenAPIFileOption) ProtoMessage

func (*OpenAPIFileOption) ProtoMessage()

func (*OpenAPIFileOption) ProtoReflect

func (x *OpenAPIFileOption) ProtoReflect() protoreflect.Message

func (*OpenAPIFileOption) Reset

func (x *OpenAPIFileOption) Reset()

func (*OpenAPIFileOption) String

func (x *OpenAPIFileOption) String() string

type OpenAPIMessageOption

OpenAPIMessageOption represents OpenAPI options on a message

type OpenAPIMessageOption struct {
    Message string          `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
    Option  *options.Schema `protobuf:"bytes,2,opt,name=option,proto3" json:"option,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIMessageOption) Descriptor

func (*OpenAPIMessageOption) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIMessageOption.ProtoReflect.Descriptor instead.

func (*OpenAPIMessageOption) GetMessage

func (x *OpenAPIMessageOption) GetMessage() string

func (*OpenAPIMessageOption) GetOption

func (x *OpenAPIMessageOption) GetOption() *options.Schema

func (*OpenAPIMessageOption) ProtoMessage

func (*OpenAPIMessageOption) ProtoMessage()

func (*OpenAPIMessageOption) ProtoReflect

func (x *OpenAPIMessageOption) ProtoReflect() protoreflect.Message

func (*OpenAPIMessageOption) Reset

func (x *OpenAPIMessageOption) Reset()

func (*OpenAPIMessageOption) String

func (x *OpenAPIMessageOption) String() string

type OpenAPIMethodOption

OpenAPIMethodOption represents OpenAPI options on a method

type OpenAPIMethodOption struct {
    Method string             `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
    Option *options.Operation `protobuf:"bytes,2,opt,name=option,proto3" json:"option,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIMethodOption) Descriptor

func (*OpenAPIMethodOption) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIMethodOption.ProtoReflect.Descriptor instead.

func (*OpenAPIMethodOption) GetMethod

func (x *OpenAPIMethodOption) GetMethod() string

func (*OpenAPIMethodOption) GetOption

func (x *OpenAPIMethodOption) GetOption() *options.Operation

func (*OpenAPIMethodOption) ProtoMessage

func (*OpenAPIMethodOption) ProtoMessage()

func (*OpenAPIMethodOption) ProtoReflect

func (x *OpenAPIMethodOption) ProtoReflect() protoreflect.Message

func (*OpenAPIMethodOption) Reset

func (x *OpenAPIMethodOption) Reset()

func (*OpenAPIMethodOption) String

func (x *OpenAPIMethodOption) String() string

type OpenAPIOptions

OpenAPIOptions represents OpenAPI protobuf options

type OpenAPIOptions struct {
    File    []*OpenAPIFileOption    `protobuf:"bytes,1,rep,name=file,proto3" json:"file,omitempty"`
    Method  []*OpenAPIMethodOption  `protobuf:"bytes,2,rep,name=method,proto3" json:"method,omitempty"`
    Message []*OpenAPIMessageOption `protobuf:"bytes,3,rep,name=message,proto3" json:"message,omitempty"`
    Service []*OpenAPIServiceOption `protobuf:"bytes,4,rep,name=service,proto3" json:"service,omitempty"`
    Field   []*OpenAPIFieldOption   `protobuf:"bytes,5,rep,name=field,proto3" json:"field,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIOptions) Descriptor

func (*OpenAPIOptions) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIOptions.ProtoReflect.Descriptor instead.

func (*OpenAPIOptions) GetField

func (x *OpenAPIOptions) GetField() []*OpenAPIFieldOption

func (*OpenAPIOptions) GetFile

func (x *OpenAPIOptions) GetFile() []*OpenAPIFileOption

func (*OpenAPIOptions) GetMessage

func (x *OpenAPIOptions) GetMessage() []*OpenAPIMessageOption

func (*OpenAPIOptions) GetMethod

func (x *OpenAPIOptions) GetMethod() []*OpenAPIMethodOption

func (*OpenAPIOptions) GetService

func (x *OpenAPIOptions) GetService() []*OpenAPIServiceOption

func (*OpenAPIOptions) ProtoMessage

func (*OpenAPIOptions) ProtoMessage()

func (*OpenAPIOptions) ProtoReflect

func (x *OpenAPIOptions) ProtoReflect() protoreflect.Message

func (*OpenAPIOptions) Reset

func (x *OpenAPIOptions) Reset()

func (*OpenAPIOptions) String

func (x *OpenAPIOptions) String() string

type OpenAPIServiceOption

OpenAPIServiceOption represents OpenAPI options on a service

type OpenAPIServiceOption struct {
    Service string       `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` // ex: Service
    Option  *options.Tag `protobuf:"bytes,2,opt,name=option,proto3" json:"option,omitempty"`
    // contains filtered or unexported fields
}

func (*OpenAPIServiceOption) Descriptor

func (*OpenAPIServiceOption) Descriptor() ([]byte, []int)

Deprecated: Use OpenAPIServiceOption.ProtoReflect.Descriptor instead.

func (*OpenAPIServiceOption) GetOption

func (x *OpenAPIServiceOption) GetOption() *options.Tag

func (*OpenAPIServiceOption) GetService

func (x *OpenAPIServiceOption) GetService() string

func (*OpenAPIServiceOption) ProtoMessage

func (*OpenAPIServiceOption) ProtoMessage()

func (*OpenAPIServiceOption) ProtoReflect

func (x *OpenAPIServiceOption) ProtoReflect() protoreflect.Message

func (*OpenAPIServiceOption) Reset

func (x *OpenAPIServiceOption) Reset()

func (*OpenAPIServiceOption) String

func (x *OpenAPIServiceOption) String() string