openapi

package
v0.0.0-...-d3d27b2 Latest Latest
Warning

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

Go to latest
Published: Mar 1, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ABI2Swagger

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

ABI2Swagger is the main entry point for conversion

func NewABI2Swagger

func NewABI2Swagger(conf *ABI2SwaggerConf) *ABI2Swagger

NewABI2Swagger constructor

func (*ABI2Swagger) Gen4Factory

func (c *ABI2Swagger) Gen4Factory(basePath, name string, factoryOnly, externalRegistry bool, abi *ethbinding.ABI, devdocsJSON string) *spec.Swagger

Gen4Factory generates OpenAPI for a contract factory, with a constructor, and child methods on any address

func (*ABI2Swagger) Gen4Instance

func (c *ABI2Swagger) Gen4Instance(basePath, name string, abi *ethbinding.ABI, devdocsJSON string) *spec.Swagger

Gen4Instance generates OpenAPI for a single contract instance with an address

type ABI2SwaggerConf

type ABI2SwaggerConf struct {
	ExternalHost     string
	ExternalSchemes  []string
	ExternalRootPath string
	BasicAuth        bool
	OrionPrivateAPI  bool
}

ABI2SwaggerConf are configuration options

Jump to

Keyboard shortcuts

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