generator

Documentation

Index

• Variables
• type Configuration
• type OpenAPIv3Generator
  • func NewOpenAPIv3Generator(plugin *protogen.Plugin, conf Configuration, inputFiles []*protogen.File) *OpenAPIv3Generator
  • func (g *OpenAPIv3Generator) Run(outputFile *protogen.GeneratedFile) error
• type OpenAPIv3Reflector
  • func NewOpenAPIv3Reflector(conf Configuration) *OpenAPIv3Reflector
• type Service
  • func (*Service) Descriptor() ([]byte, []int)
  • func (x *Service) GetExternalDocs() *openapiv3.ExternalDocs
  • func (x *Service) GetParameters() []*openapiv3.ParameterOrReference
  • func (x *Service) GetSecurity() []*openapiv3.SecurityRequirement
  • func (x *Service) GetServers() []*openapiv3.Server
  • func (x *Service) GetSpecificationExtension() []*openapiv3.NamedAny
  • func (x *Service) GetTags() []string
  • func (*Service) ProtoMessage()
  • func (x *Service) ProtoReflect() protoreflect.Message
  • func (x *Service) Reset()
  • func (x *Service) String() string

Variables

var (
	// optional openapi.v3.Service service = 1144;
	E_Service = &file_openapiv3_service_proto_extTypes[0]
)

Extension fields to descriptorpb.ServiceOptions.

var File_openapiv3_service_proto protoreflect.FileDescriptor

Types

type Configuration

type Configuration struct {
	Version         *string
	Title           *string
	Description     *string
	Naming          *string
	FQSchemaNaming  *bool
	EnumType        *string
	CircularDepth   *int
	DefaultResponse *bool
	OutputMode      *string
}

type OpenAPIv3Generator

type OpenAPIv3Generator struct {
	// contains filtered or unexported fields
}

OpenAPIv3Generator holds internal state needed to generate an OpenAPIv3 document for a transcoded Protocol Buffer service.

func NewOpenAPIv3Generator

func NewOpenAPIv3Generator(plugin *protogen.Plugin, conf Configuration, inputFiles []*protogen.File) *OpenAPIv3Generator

NewOpenAPIv3Generator creates a new generator for a protoc plugin invocation.

func (*OpenAPIv3Generator) Run

func (g *OpenAPIv3Generator) Run(outputFile *protogen.GeneratedFile) error

Run runs the generator.

type OpenAPIv3Reflector

type OpenAPIv3Reflector struct {
	// contains filtered or unexported fields
}

func NewOpenAPIv3Reflector

func NewOpenAPIv3Reflector(conf Configuration) *OpenAPIv3Reflector

NewOpenAPIv3Reflector creates a new reflector.

type Service

type Service struct {
	Tags                   []string                          `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
	ExternalDocs           *openapiv3.ExternalDocs           `protobuf:"bytes,2,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	Parameters             []*openapiv3.ParameterOrReference `protobuf:"bytes,3,rep,name=parameters,proto3" json:"parameters,omitempty"`
	Security               []*openapiv3.SecurityRequirement  `protobuf:"bytes,4,rep,name=security,proto3" json:"security,omitempty"`
	Servers                []*openapiv3.Server               `protobuf:"bytes,5,rep,name=servers,proto3" json:"servers,omitempty"`
	SpecificationExtension []*openapiv3.NamedAny             `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Service) Descriptor

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetExternalDocs

func (x *Service) GetExternalDocs() *openapiv3.ExternalDocs

func (*Service) GetParameters

func (x *Service) GetParameters() []*openapiv3.ParameterOrReference

func (*Service) GetSecurity

func (x *Service) GetSecurity() []*openapiv3.SecurityRequirement

func (*Service) GetServers

func (x *Service) GetServers() []*openapiv3.Server

func (*Service) GetSpecificationExtension

func (x *Service) GetSpecificationExtension() []*openapiv3.NamedAny

func (*Service) GetTags

func (x *Service) GetTags() []string

func (*Service) ProtoMessage

func (*Service) ProtoMessage()

func (*Service) ProtoReflect

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

func (*Service) Reset

func (x *Service) Reset()

func (*Service) String

func (x *Service) String() string