oapigen

package

v0.0.0-...-f9bd827 Latest Latest Go to latest Published: Aug 27, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lyda/steampipe-plugin-oapigen

Links

Open Source Insights

Documentation ¶

Overview ¶

Package oapigen generates tables from OpenAPI documents.

Index ¶

Variables
func ConfigInstance() interface{}
func Plugin(_ context.Context) *plugin.Plugin
func PluginTables(ctx context.Context, d *plugin.TableMapData) (map[string]*plugin.Table, error)
type Config
- func GetConfig(connection *plugin.Connection) Config

Constants ¶

This section is empty.

Variables ¶

View Source

var ConfigSchema = map[string]*schema.Attribute{
	"version": {
		Type:     schema.TypeInt,
		Required: true,
	},
	"documents": {
		Type:     schema.TypeList,
		Elem:     &schema.Attribute{Type: schema.TypeString},
		Required: true,
	},
	"prefix": {
		Type:     schema.TypeString,
		Required: true,
	},
}

ConfigSchema defines the config params for the oapigen plugin.

Functions ¶

func ConfigInstance ¶

func ConfigInstance() interface{}

ConfigInstance returns a Config pointer.

func Plugin ¶

func Plugin(_ context.Context) *plugin.Plugin

Plugin defines the oapigen plugin.

func PluginTables ¶

func PluginTables(ctx context.Context, d *plugin.TableMapData) (map[string]*plugin.Table, error)

PluginTables defines all the tables from the OpenaAPI documents.

Types ¶

type Config ¶

type Config struct {
	Version   int      `cty:"version"`
	Documents []string `cty:"documents" steampipe:"watch"`
	Prefix    *string  `cty:"prefix"`
}

Config is a go type to represent the plugin config.

func GetConfig ¶

func GetConfig(connection *plugin.Connection) Config

GetConfig :: retrieve and cast connection config from query data

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL