client

Documentation

Index

• Constants
• Variables
• type CEDARCoreAPI
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *CEDARCoreAPI
  • func NewHTTPClient(formats strfmt.Registry) *CEDARCoreAPI
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *CEDARCoreAPI
  • func (c *CEDARCoreAPI) 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 = "webmethods-apigw.cedar.cms.gov"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/gateway/CEDAR Core API/2.0.0"
)

Variables

var Default = NewHTTPClient(nil)

Default c e d a r core API HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type CEDARCoreAPI

type CEDARCoreAPI struct {
	AuthorityToOperate authority_to_operate.ClientService

	Budget budget.ClientService

	BudgetSystemCost budget_system_cost.ClientService

	Component component.ClientService

	Contract contract.ClientService

	CostType cost_type.ClientService

	DataCenter data_center.ClientService

	Deployment deployment.ClientService

	DomainModel domain_model.ClientService

	Enumeration enumeration.ClientService

	Exchange exchange.ClientService

	Organization organization.ClientService

	Person person.ClientService

	Role role.ClientService

	SoftwareProducts software_products.ClientService

	Stakeholder stakeholder.ClientService

	SupportContact support_contact.ClientService

	System system.ClientService

	Threat threat.ClientService

	URL url.ClientService

	User user.ClientService

	Transport runtime.ClientTransport
}

CEDARCoreAPI is a client for c e d a r core API

func New

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

New creates a new c e d a r core API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *CEDARCoreAPI

NewHTTPClient creates a new c e d a r core API HTTP client.

func NewHTTPClientWithConfig

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

NewHTTPClientWithConfig creates a new c e d a r core API HTTP client, using a customizable transport config.

func (*CEDARCoreAPI) SetTransport

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