plumbing

Documentation

Overview

Package plumbing provides an auto-generated Go client for accessing Netlify's API.

See https://goswagger.io/generate/client.html for more example usage of an API client generated by go-swagger.

Example

server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
	rw.Header().Set("Content-Type", "application/json; charset=utf-8")
	rw.Write([]byte(`{ "name": "Pets of Netlify" }`))
}))
defer server.Close()
host := strings.ReplaceAll(server.URL, "http://", "")

// Create the API client
// For Netlify's production API use DefaultHost, DefaultBasePath, DefaultSchemes
transport := httptransport.New(host, DefaultBasePath, []string{"http"})
client := New(transport, strfmt.Default)

// Prepare the API token
authInfo := runtime.ClientAuthInfoWriterFunc(func(r runtime.ClientRequest, _ strfmt.Registry) error {
	r.SetHeaderParam("User-Agent", "Your app")
	r.SetHeaderParam("Authorization", "Bearer your_netlify_api_token")
	return nil
})

// Make a request
params := operations.NewGetSiteParams()
params.SiteID = "123"
res, err := client.Operations.GetSite(params, authInfo)
if err != nil {
	log.Fatal(err)
}
fmt.Println(res.Payload.Name)

Output:

Pets of Netlify

Index

• Constants
• Variables
• type Netlify
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Netlify
  • func NewHTTPClient(formats strfmt.Registry) *Netlify
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Netlify
  • func (c *Netlify) 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

Examples

• Package

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "api.netlify.com"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api/v1"
)

Variables

var Default = NewHTTPClient(nil)

Default netlify HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type Netlify

type Netlify struct {
	Operations operations.ClientService

	Transport runtime.ClientTransport
}

Netlify is a client for netlify

func New

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

New creates a new netlify client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Netlify

NewHTTPClient creates a new netlify HTTP client.

func NewHTTPClientWithConfig

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

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

func (*Netlify) SetTransport

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