gnostic_plugin_v1

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 6, 2020 License: Apache-2.0 Imports: 16 Imported by: 0

README

Plugins

This directory contains support code for building Gnostic plugins and associated examples.

Plugins are used to process API descriptions and can perform tasks like documentation and code generation. Plugins can be written in any language that is supported by the Protocol Buffer tools.

This directory contains several sample plugins and two support tools that make it easier to test plugins by running them standalone.

  • gnostic-plugin-request is a plugin that captures a plugin request and writes it in .json and binary .pb form. When the optional -verbose flag is provided, this plugin logs the request to stdout.
  • gnostic-process-plugin-response is a standalone tool that reads a plugin response on stdin and handles the response in the same way that gnostic does.

For example, this writes the plugin request to local files plugin-request.json and plugin-request.pb.

% gnostic myapi.json --plugin-request-out=.

Then a plugin can be run standalone:

% gnostic-go-generator --plugin < plugin-request.pb > plugin-response.pb

Then you can use the following to process the plugin response:

% gnostic-process-plugin-response -output=. < plugin-response.pb

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Message_Level_name = map[int32]string{
	0: "UNKNOWN",
	1: "INFO",
	2: "WARNING",
	3: "ERROR",
	4: "FATAL",
}
View Source 
var Message_Level_value = map[string]int32{
	"UNKNOWN": 0,
	"INFO":    1,
	"WARNING": 2,
	"ERROR":   3,
	"FATAL":   4,
}

Functions

func HandleResponse 

func HandleResponse(response *Response, outputLocation string) error

Types

type Environment 

type Environment struct {
	Request         *Request  // plugin request object
	Response        *Response // response message
	Invocation      string    // string representation of call
	RunningAsPlugin bool      // true if app is being run as a plugin
	Verbose         bool      // if true, plugin should log details to stderr
}

Environment contains the environment of a plugin call.

func NewEnvironment 

func NewEnvironment() (env *Environment, err error)

NewEnvironment creates a plugin context from arguments and standard input.

func (*Environment) RespondAndExit 

func (env *Environment) RespondAndExit()

RespondAndExit serializes and returns the plugin response and then exits.

func (*Environment) RespondAndExitIfError 

func (env *Environment) RespondAndExitIfError(err error)

RespondAndExitIfError checks an error and if it is non-nil, records it and serializes and returns the response and then exits.

type File 

type File struct {
	// name of the file
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// data to be written to the file
	Data                 []byte   `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

File describes a file generated by a plugin.

func (*File) Descriptor 

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

func (*File) GetData 

func (m *File) GetData() []byte

func (*File) GetName 

func (m *File) GetName() string

func (*File) ProtoMessage 

func (*File) ProtoMessage()

func (*File) Reset 

func (m *File) Reset()

func (*File) String 

func (m *File) String() string

func (*File) XXX_DiscardUnknown added in v0.3.1 

func (m *File) XXX_DiscardUnknown()

func (*File) XXX_Marshal added in v0.3.1 

func (m *File) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*File) XXX_Merge added in v0.3.1 

func (m *File) XXX_Merge(src proto.Message)

func (*File) XXX_Size added in v0.3.1 

func (m *File) XXX_Size() int

func (*File) XXX_Unmarshal added in v0.3.1 

func (m *File) XXX_Unmarshal(b []byte) error

type Message added in v0.2.0 

type Message struct {
	// message severity
	Level Message_Level `protobuf:"varint,1,opt,name=level,proto3,enum=gnostic.plugin.v1.Message_Level" json:"level,omitempty"`
	// a unique message identifier
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// message text
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// an associated key path in an API description
	Keys                 []string `protobuf:"bytes,4,rep,name=keys,proto3" json:"keys,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Plugins can return messages to be collated and reported by gnostic.

func (*Message) Descriptor added in v0.2.0 

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

func (*Message) GetCode added in v0.2.0 

func (m *Message) GetCode() string

func (*Message) GetKeys added in v0.2.0 

func (m *Message) GetKeys() []string

func (*Message) GetLevel added in v0.2.0 

func (m *Message) GetLevel() Message_Level

func (*Message) GetText added in v0.2.0 

func (m *Message) GetText() string

func (*Message) ProtoMessage added in v0.2.0 

func (*Message) ProtoMessage()

func (*Message) Reset added in v0.2.0 

func (m *Message) Reset()

func (*Message) String added in v0.2.0 

func (m *Message) String() string

func (*Message) XXX_DiscardUnknown added in v0.3.1 

func (m *Message) XXX_DiscardUnknown()

func (*Message) XXX_Marshal added in v0.3.1 

func (m *Message) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Message) XXX_Merge added in v0.3.1 

func (m *Message) XXX_Merge(src proto.Message)

func (*Message) XXX_Size added in v0.3.1 

func (m *Message) XXX_Size() int

func (*Message) XXX_Unmarshal added in v0.3.1 

func (m *Message) XXX_Unmarshal(b []byte) error

type Message_Level added in v0.2.0 

type Message_Level int32
const (
	Message_UNKNOWN Message_Level = 0
	Message_INFO    Message_Level = 1
	Message_WARNING Message_Level = 2
	Message_ERROR   Message_Level = 3
	Message_FATAL   Message_Level = 4
)

func (Message_Level) EnumDescriptor added in v0.2.0 

func (Message_Level) EnumDescriptor() ([]byte, []int)

func (Message_Level) String added in v0.2.0 

func (x Message_Level) String() string

type Messages added in v0.2.0 

type Messages struct {
	Messages             []*Message `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*Messages) Descriptor added in v0.2.0 

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

func (*Messages) GetMessages added in v0.2.0 

func (m *Messages) GetMessages() []*Message

func (*Messages) ProtoMessage added in v0.2.0 

func (*Messages) ProtoMessage()

func (*Messages) Reset added in v0.2.0 

func (m *Messages) Reset()

func (*Messages) String added in v0.2.0 

func (m *Messages) String() string

func (*Messages) XXX_DiscardUnknown added in v0.3.1 

func (m *Messages) XXX_DiscardUnknown()

func (*Messages) XXX_Marshal added in v0.3.1 

func (m *Messages) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Messages) XXX_Merge added in v0.3.1 

func (m *Messages) XXX_Merge(src proto.Message)

func (*Messages) XXX_Size added in v0.3.1 

func (m *Messages) XXX_Size() int

func (*Messages) XXX_Unmarshal added in v0.3.1 

func (m *Messages) XXX_Unmarshal(b []byte) error

type Parameter 

type Parameter struct {
	// The name of the parameter as specified in the option string
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The parameter value as specified in the option string
	Value                string   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A parameter passed to the plugin from (or through) gnostic.

func (*Parameter) Descriptor 

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

func (*Parameter) GetName 

func (m *Parameter) GetName() string

func (*Parameter) GetValue 

func (m *Parameter) GetValue() string

func (*Parameter) ProtoMessage 

func (*Parameter) ProtoMessage()

func (*Parameter) Reset 

func (m *Parameter) Reset()

func (*Parameter) String 

func (m *Parameter) String() string

func (*Parameter) XXX_DiscardUnknown added in v0.3.1 

func (m *Parameter) XXX_DiscardUnknown()

func (*Parameter) XXX_Marshal added in v0.3.1 

func (m *Parameter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Parameter) XXX_Merge added in v0.3.1 

func (m *Parameter) XXX_Merge(src proto.Message)

func (*Parameter) XXX_Size added in v0.3.1 

func (m *Parameter) XXX_Size() int

func (*Parameter) XXX_Unmarshal added in v0.3.1 

func (m *Parameter) XXX_Unmarshal(b []byte) error

type Request 

type Request struct {
	// filename or URL of the original source document
	SourceName string `protobuf:"bytes,1,opt,name=source_name,json=sourceName,proto3" json:"source_name,omitempty"`
	// Output path specified in the plugin invocation.
	OutputPath string `protobuf:"bytes,2,opt,name=output_path,json=outputPath,proto3" json:"output_path,omitempty"`
	// Plugin parameters parsed from the invocation string.
	Parameters []*Parameter `protobuf:"bytes,3,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// The version number of gnostic.
	CompilerVersion *Version `protobuf:"bytes,4,opt,name=compiler_version,json=compilerVersion,proto3" json:"compiler_version,omitempty"`
	// API models
	Models               []*any.Any `protobuf:"bytes,5,rep,name=models,proto3" json:"models,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

An encoded Request is written to the plugin's stdin.

func (*Request) AddModel added in v0.2.0 

func (request *Request) AddModel(modelType string, model proto.Message) error

func (*Request) Descriptor 

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

func (*Request) GetCompilerVersion 

func (m *Request) GetCompilerVersion() *Version

func (*Request) GetModels added in v0.2.0 

func (m *Request) GetModels() []*any.Any

func (*Request) GetOutputPath 

func (m *Request) GetOutputPath() string

func (*Request) GetParameters 

func (m *Request) GetParameters() []*Parameter

func (*Request) GetSourceName 

func (m *Request) GetSourceName() string

func (*Request) ProtoMessage 

func (*Request) ProtoMessage()

func (*Request) Reset 

func (m *Request) Reset()

func (*Request) String 

func (m *Request) String() string

func (*Request) XXX_DiscardUnknown added in v0.3.1 

func (m *Request) XXX_DiscardUnknown()

func (*Request) XXX_Marshal added in v0.3.1 

func (m *Request) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Request) XXX_Merge added in v0.3.1 

func (m *Request) XXX_Merge(src proto.Message)

func (*Request) XXX_Size added in v0.3.1 

func (m *Request) XXX_Size() int

func (*Request) XXX_Unmarshal added in v0.3.1 

func (m *Request) XXX_Unmarshal(b []byte) error

type Response 

type Response struct {
	// Error message.  If non-empty, the plugin failed.
	// The plugin process should exit with status code zero
	// even if it reports an error in this way.
	//
	// This should be used to indicate errors which prevent the plugin from
	// operating as intended.  Errors which indicate a problem in gnostic
	// itself -- such as the input Document being unparseable -- should be
	// reported by writing a message to stderr and exiting with a non-zero
	// status code.
	Errors []string `protobuf:"bytes,1,rep,name=errors,proto3" json:"errors,omitempty"`
	// file output, each file will be written by gnostic to an appropriate location.
	Files []*File `protobuf:"bytes,2,rep,name=files,proto3" json:"files,omitempty"`
	// informational messages to be collected and reported by gnostic.
	Messages             []*Message `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

The plugin writes an encoded Response to stdout.

func (*Response) Descriptor 

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

func (*Response) GetErrors 

func (m *Response) GetErrors() []string

func (*Response) GetFiles 

func (m *Response) GetFiles() []*File

func (*Response) GetMessages added in v0.2.0 

func (m *Response) GetMessages() []*Message

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) Reset 

func (m *Response) Reset()

func (*Response) String 

func (m *Response) String() string

func (*Response) XXX_DiscardUnknown added in v0.3.1 

func (m *Response) XXX_DiscardUnknown()

func (*Response) XXX_Marshal added in v0.3.1 

func (m *Response) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Response) XXX_Merge added in v0.3.1 

func (m *Response) XXX_Merge(src proto.Message)

func (*Response) XXX_Size added in v0.3.1 

func (m *Response) XXX_Size() int

func (*Response) XXX_Unmarshal added in v0.3.1 

func (m *Response) XXX_Unmarshal(b []byte) error

type Version 

type Version struct {
	Major int32 `protobuf:"varint,1,opt,name=major,proto3" json:"major,omitempty"`
	Minor int32 `protobuf:"varint,2,opt,name=minor,proto3" json:"minor,omitempty"`
	Patch int32 `protobuf:"varint,3,opt,name=patch,proto3" json:"patch,omitempty"`
	// A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
	// be empty for mainline stable releases.
	Suffix               string   `protobuf:"bytes,4,opt,name=suffix,proto3" json:"suffix,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

The version number of gnostic.

func (*Version) Descriptor 

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

func (*Version) GetMajor 

func (m *Version) GetMajor() int32

func (*Version) GetMinor 

func (m *Version) GetMinor() int32

func (*Version) GetPatch 

func (m *Version) GetPatch() int32

func (*Version) GetSuffix 

func (m *Version) GetSuffix() string

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) Reset 

func (m *Version) Reset()

func (*Version) String 

func (m *Version) String() string

func (*Version) XXX_DiscardUnknown added in v0.3.1 

func (m *Version) XXX_DiscardUnknown()

func (*Version) XXX_Marshal added in v0.3.1 

func (m *Version) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Version) XXX_Merge added in v0.3.1 

func (m *Version) XXX_Merge(src proto.Message)

func (*Version) XXX_Size added in v0.3.1 

func (m *Version) XXX_Size() int

func (*Version) XXX_Unmarshal added in v0.3.1 

func (m *Version) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Directories

Path Synopsis
gnostic_analyze is a tool for analyzing OpenAPI descriptions.
 gnostic_analyze is a tool for analyzing OpenAPI descriptions.
statistics
summarize command
summarize is a tool for summarizing the results of gnostic_analyze runs.
 summarize is a tool for summarizing the results of gnostic_analyze runs.
gnostic-plugin-request is a development tool that captures and optionally displays the contents of the gnostic plugin interface.
 gnostic-plugin-request is a development tool that captures and optionally displays the contents of the gnostic plugin interface.
gnostic-process-plugin-response is a development tool that processes the output of a gnostic plugin in the same way that it would be handled by gnostic itself.
 gnostic-process-plugin-response is a development tool that processes the output of a gnostic plugin in the same way that it would be handled by gnostic itself.
gnostic_go_generator is a sample Gnostic plugin that generates Go code that supports an API.
 gnostic_go_generator is a sample Gnostic plugin that generates Go code that supports an API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.