v20240312

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.13.4 DO NOT EDIT.

Index

• Constants
• func NewCreateWorkspaceRequestWithApplicationVndAPIPlusJSONBody(server string, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*http.Request, error)
• func NewCreateWorkspaceRequestWithBody(server string, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*http.Request, error)
• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
  • func (c *Client) CreateWorkspaceWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*http.Response, error)
  • func (c *Client) CreateWorkspaceWithBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*http.Response, error)
• type ClientInterface
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer HttpRequestDoer) ClientOption
  • func WithRequestEditorFn(fn RequestEditorFn) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func (c *ClientWithResponses) CreateWorkspaceWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*CreateWorkspaceResponse, error)
  • func (c *ClientWithResponses) CreateWorkspaceWithBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, ...) (*CreateWorkspaceResponse, error)
• type ClientWithResponsesInterface
• type CreateWorkspaceApplicationVndAPIPlusJSONRequestBody
• type CreateWorkspaceParams
• type CreateWorkspaceParamsContentType
• type CreateWorkspaceResponse
  • func ParseCreateWorkspaceResponse(rsp *http.Response) (*CreateWorkspaceResponse, error)
  • func (r CreateWorkspaceResponse) Status() string
  • func (r CreateWorkspaceResponse) StatusCode() int
• type HttpRequestDoer
• type RequestEditorFn

Constants

const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Functions

func NewCreateWorkspaceRequestWithApplicationVndAPIPlusJSONBody

func NewCreateWorkspaceRequestWithApplicationVndAPIPlusJSONBody(server string, orgId externalRef2.OrgId, params *CreateWorkspaceParams, body CreateWorkspaceApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewCreateWorkspaceRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateWorkspace builder with application/vnd.api+json body

func NewCreateWorkspaceRequestWithBody

func NewCreateWorkspaceRequestWithBody(server string, orgId externalRef2.OrgId, params *CreateWorkspaceParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateWorkspaceRequestWithBody generates requests for CreateWorkspace with any type of body

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 HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateWorkspaceWithApplicationVndAPIPlusJSONBody

func (c *Client) CreateWorkspaceWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, body CreateWorkspaceApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateWorkspaceWithBody

func (c *Client) CreateWorkspaceWithBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// CreateWorkspaceWithBody request with any body
	CreateWorkspaceWithBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateWorkspaceWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, body CreateWorkspaceApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

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

func (*ClientWithResponses) CreateWorkspaceWithApplicationVndAPIPlusJSONBodyWithResponse

func (c *ClientWithResponses) CreateWorkspaceWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, body CreateWorkspaceApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkspaceResponse, error)

func (*ClientWithResponses) CreateWorkspaceWithBodyWithResponse

func (c *ClientWithResponses) CreateWorkspaceWithBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorkspaceResponse, error)

CreateWorkspaceWithBodyWithResponse request with arbitrary body returning *CreateWorkspaceResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// CreateWorkspaceWithBodyWithResponse request with any body
	CreateWorkspaceWithBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorkspaceResponse, error)

	CreateWorkspaceWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateWorkspaceParams, body CreateWorkspaceApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkspaceResponse, error)
}

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

type CreateWorkspaceApplicationVndAPIPlusJSONRequestBody

type CreateWorkspaceApplicationVndAPIPlusJSONRequestBody = externalRef3.WorkspacePostRequest

CreateWorkspaceApplicationVndAPIPlusJSONRequestBody defines body for CreateWorkspace for application/vnd.api+json ContentType.

type CreateWorkspaceParams

type CreateWorkspaceParams struct {
	// Version The requested version of the endpoint to process the request
	Version externalRef0.Version `form:"version" json:"version"`

	// SnykRequestId Request ID
	SnykRequestId externalRef2.RequestId `json:"snyk-request-id"`

	// UserAgent The client that sent the request, as per RFC 7231.
	UserAgent externalRef2.UserAgent `json:"user-agent"`

	// ContentType Content type header
	ContentType CreateWorkspaceParamsContentType `json:"content-type"`
}

CreateWorkspaceParams defines parameters for CreateWorkspace.

type CreateWorkspaceParamsContentType

type CreateWorkspaceParamsContentType string

CreateWorkspaceParamsContentType defines parameters for CreateWorkspace.

const (
	ApplicationvndApiJson CreateWorkspaceParamsContentType = "application/vnd.api+json"
)

Defines values for CreateWorkspaceParamsContentType.

type CreateWorkspaceResponse

type CreateWorkspaceResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *externalRef3.WorkspacePostResponse
	ApplicationvndApiJSON400 *externalRef0.N400
	ApplicationvndApiJSON401 *externalRef0.N401
	ApplicationvndApiJSON403 *externalRef0.N403
	ApplicationvndApiJSON500 *externalRef0.N500
}

func ParseCreateWorkspaceResponse

func ParseCreateWorkspaceResponse(rsp *http.Response) (*CreateWorkspaceResponse, error)

ParseCreateWorkspaceResponse parses an HTTP response from a CreateWorkspaceWithResponse call

func (CreateWorkspaceResponse) Status

func (r CreateWorkspaceResponse) Status() string

Status returns HTTPResponse.Status

func (CreateWorkspaceResponse) StatusCode

func (r CreateWorkspaceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function