client

Documentation

Index

• Constants
• Variables
• type FireHydrantAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *FireHydrantAPI
  • func NewHTTPClient(formats strfmt.Registry) *FireHydrantAPI
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *FireHydrantAPI
  • func (c *FireHydrantAPI) 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 = "api.firehydrant.io"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default fire hydrant API HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type FireHydrantAPI

type FireHydrantAPI struct {
	AccountSettings account_settings.ClientService

	Alerts alerts.ClientService

	Audiences audiences.ClientService

	Changes changes.ClientService

	Communication communication.ClientService

	Conversations conversations.ClientService

	Environments environments.ClientService

	Functionalities functionalities.ClientService

	IncidentSettings incident_settings.ClientService

	Incidents incidents.ClientService

	Integrations integrations.ClientService

	Reporting reporting.ClientService

	Retrospectives retrospectives.ClientService

	Runbooks runbooks.ClientService

	Scim s_c_i_m.ClientService

	Services services.ClientService

	Signals signals.ClientService

	StatusPages status_pages.ClientService

	Tasks tasks.ClientService

	Teams teams.ClientService

	Ticketing ticketing.ClientService

	Users users.ClientService

	Webhooks webhooks.ClientService

	Transport runtime.ClientTransport
}

FireHydrantAPI is a client for fire hydrant API

func New

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

New creates a new fire hydrant API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *FireHydrantAPI

NewHTTPClient creates a new fire hydrant API HTTP client.

func NewHTTPClientWithConfig

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

NewHTTPClientWithConfig creates a new fire hydrant API HTTP client, using a customizable transport config.

func (*FireHydrantAPI) SetTransport

func (c *FireHydrantAPI) 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.