package
0.2.2
Repository: https://github.com/nytimes/openapi2proto.git
Documentation: pkg.go.dev

# Functions

NewEncoder creates an Encoder object that writes the encoded Protocol Buffers declaration to `dst`.
NewEnum creates an Enum object.
NewExtension creates an Extension object.
NewExtensionField creates an ExtensionField object.
NewField creates a new Field object.
NewGlobalOption creates a GlobalOption.
NewHTTPAnnotation creates an HTTPAnnotation object.
NewMap creates a map type.
NewMessage creates a new Message.
NewPackage creates a Package object.
NewReference creates.
NewRPC creates a new RPC object.
NewRPCOption create an RPCOption object.
NewService creates a Service object.
Resolve takes a package, and resolves internal references.
WithIndent creates a new Option to control the indentation for the encoded definition.

# Variables

Boxed types.
Builtin types.
Boxed types.
Builtin types.
Boxed types.
Builtin types.
Boxed types.
Builtin types.
Boxed types.
Builtin types.
Boxed types.
Builtin types.
Boxed types.
list type.
Boxed types.
Builtin types.
Boxed types.
value type.

# Structs

Encoder is responsible for taking a protobuf.Package object and encodes it into textual representation.
Enum represents a Protocol Buffers enum type.
Extension represents an extended message.
ExtensionField is a field in an extended field.
Field is a field in a Message.
GlobalOption represents a Protocol Buffers global option.
HTTPAnnotation represents a google.api.http option.
Map represents a Protocol Buffers map type.
Message is a composite type.
Package represnets a Protocol Buffers Package.
Reference is a special type of Type that can pass the protobuf.Type system, but requires that it be resolved at runtime to get the actual Type behind it.
RPC represents an RPC call associated with a Service.
RPCOption represents simple rpc options.
Service defines a service with many RPC endpoints.

# Interfaces

Container is a special type that can have child types.
Type is an interface to group different Protocol Buffer types.

# Type aliases

Builtin represents a Protocol Buffers builting type.
Option is used to pass options to several methods.
ResolveFunc is the function used to resolve `$ref` strings to an actual protobuf.Type.