client

Documentation

Index

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

Variables

var Default = NewHTTPClient(nil)

Default bitbucket API HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type BitbucketAPI

type BitbucketAPI struct {
	Addon addon.ClientService

	BranchingModel branching_model.ClientService

	Branchrestrictions branchrestrictions.ClientService

	Commits commits.ClientService

	Deploy deploy.ClientService

	Deployments deployments.ClientService

	Downloads downloads.ClientService

	IssueTracker issue_tracker.ClientService

	Operations operations.ClientService

	Pipelines pipelines.ClientService

	Projects projects.ClientService

	Properties properties.ClientService

	Pullrequests pullrequests.ClientService

	Refs refs.ClientService

	Reports reports.ClientService

	Repositories repositories.ClientService

	Search search.ClientService

	Snippet snippet.ClientService

	Snippets snippets.ClientService

	Source source.ClientService

	SSH ssh.ClientService

	Teams teams.ClientService

	Users users.ClientService

	Webhooks webhooks.ClientService

	Workspaces workspaces.ClientService

	Transport runtime.ClientTransport
}

BitbucketAPI is a client for bitbucket API

func New

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

New creates a new bitbucket API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *BitbucketAPI

NewHTTPClient creates a new bitbucket API HTTP client.

func NewHTTPClientWithConfig

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

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

func (*BitbucketAPI) SetTransport

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