client

Documentation

Index

• Constants
• Variables
• type NetBoxAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *NetBoxAPI
  • func NewHTTPClient(formats strfmt.Registry) *NetBoxAPI
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *NetBoxAPI
  • func (c *NetBoxAPI) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost:8000"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api"
)

Variables

var Default = NewHTTPClient(nil)

Default net box API HTTP client.

var DefaultSchemes = []string{"http"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type NetBoxAPI

type NetBoxAPI struct {
	Circuits circuits.ClientService

	Dcim dcim.ClientService

	Extras extras.ClientService

	Ipam ipam.ClientService

	Secrets secrets.ClientService

	Tenancy tenancy.ClientService

	Users users.ClientService

	Virtualization virtualization.ClientService

	Transport runtime.ClientTransport
}

NetBoxAPI is a client for net box API

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *NetBoxAPI

New creates a new net box API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *NetBoxAPI

NewHTTPClient creates a new net box API HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *NetBoxAPI

NewHTTPClientWithConfig creates a new net box API HTTP client, using a customizable transport config.

func (*NetBoxAPI) SetTransport

func (c *NetBoxAPI) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.