project

Documentation

Overview

Package project provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version v0.5.1 DO NOT EDIT.

Index

• func NewCreateRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
• func NewDeleteRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
• func NewGetRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
• type Client
  • func NewClient(server string, httpClient common.Client) *Client
  • func (c *Client) Create(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) Delete(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
  • func (c *Client) Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
• type ClientInterface
• type ClientWithResponses
  • func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses
  • func (c *ClientWithResponses) CreateWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateResponse, error)
  • func (c *ClientWithResponses) DeleteWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
  • func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)
  • func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
  • func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
  • func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
• type ClientWithResponsesInterface
• type CreateResponse
  • func (r CreateResponse) Status() string
  • func (r CreateResponse) StatusCode() int
• type DeleteResponse
  • func (r DeleteResponse) Status() string
  • func (r DeleteResponse) StatusCode() int
• type GetResponse
  • func (r GetResponse) Status() string
  • func (r GetResponse) StatusCode() int
• type RequestEditorFn

Functions

func NewCreateRequest

func NewCreateRequest(ctx context.Context, server string, projectID string) (*http.Request, error)

NewCreateRequest generates requests for Create

func NewDeleteRequest

func NewDeleteRequest(ctx context.Context, server string, projectID string) (*http.Request, error)

NewDeleteRequest generates requests for Delete

func NewGetRequest

func NewGetRequest(ctx context.Context, server string, projectID string) (*http.Request, error)

NewGetRequest generates requests for Get

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client common.Client
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, httpClient common.Client) *Client

Creates a new Client, with reasonable defaults

func (*Client) Create

func (c *Client) Create(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// Delete request
	Delete(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Get request
	Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Create request
	Create(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateWithResponse

func (c *ClientWithResponses) CreateWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateResponse, error)

CreateWithResponse request returning *CreateResponse

func (*ClientWithResponses) DeleteWithResponse

func (c *ClientWithResponses) DeleteWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

DeleteWithResponse request returning *DeleteResponse

func (*ClientWithResponses) GetWithResponse

func (c *ClientWithResponses) GetWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)

GetWithResponse request returning *GetResponse

func (*ClientWithResponses) ParseCreateResponse

func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)

ParseCreateResponse parses an HTTP response from a CreateWithResponse call

func (*ClientWithResponses) ParseDeleteResponse

func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)

ParseDeleteResponse parses an HTTP response from a DeleteWithResponse call

func (*ClientWithResponses) ParseGetResponse

func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)

ParseGetResponse parses an HTTP response from a GetWithResponse call

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// Delete request
	DeleteWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

	// Get request
	GetWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)

	// Create request
	CreateWithResponse(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateResponse

type CreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Project Project ID
		Project string `json:"project"`

		// Scope Project Scope
		Scope interface{} `json:"scope"`
	}
	JSON201 *struct {
		// Project Project ID
		Project string `json:"project"`

		// Scope Project Scope
		Scope interface{} `json:"scope"`
	}
	JSON403 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON409 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON422 *struct {
		Details *[]struct {
			Loc  []string `json:"loc"`
			Msg  string   `json:"msg"`
			Type string   `json:"type"`
		} `json:"detail,omitempty"`
	}
	JSON500 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	HasError error // Aggregated error
}

func (CreateResponse) Status

func (r CreateResponse) Status() string

Status returns HTTPResponse.Status

func (CreateResponse) StatusCode

func (r CreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteResponse

type DeleteResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Project Project ID
		Project string `json:"project"`

		// Scope Project Scope
		Scope interface{} `json:"scope"`
	}
	JSON400 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON403 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON404 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON422 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON500 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	HasError error // Aggregated error
}

func (DeleteResponse) Status

func (r DeleteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteResponse) StatusCode

func (r DeleteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetResponse

type GetResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Project Project ID
		Project string `json:"project"`

		// Scope Project Scope
		Scope interface{} `json:"scope"`
	}
	JSON403 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON404 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	JSON422 *struct {
		Details *[]struct {
			Loc  []string `json:"loc"`
			Msg  string   `json:"msg"`
			Type string   `json:"type"`
		} `json:"detail,omitempty"`
	}
	JSON500 *struct {
		Details []struct {
			Key string `json:"key"`
			Msg string `json:"msg"`
		} `json:"detail"`
	}
	HasError error // Aggregated error
}

func (GetResponse) Status

func (r GetResponse) Status() string

Status returns HTTPResponse.Status

func (GetResponse) StatusCode

func (r GetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function