internal

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGenerateSubdomainRequest 

func NewGenerateSubdomainRequest(server string) (*http.Request, error)

NewGenerateSubdomainRequest generates requests for GenerateSubdomain

func NewGetOverviewRequest 

func NewGetOverviewRequest(server string) (*http.Request, error)

NewGetOverviewRequest generates requests for GetOverview

func NewSubdomainAcmeChallengeRequest 

func NewSubdomainAcmeChallengeRequest(server string, subdomainId openapi_types.UUID, body SubdomainAcmeChallengeJSONRequestBody) (*http.Request, error)

NewSubdomainAcmeChallengeRequest calls the generic SubdomainAcmeChallenge builder with application/json body

func NewSubdomainAcmeChallengeRequestWithBody 

func NewSubdomainAcmeChallengeRequestWithBody(server string, subdomainId openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)

NewSubdomainAcmeChallengeRequestWithBody generates requests for SubdomainAcmeChallenge 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) GenerateSubdomain 

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

func (*Client) GetOverview 

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

func (*Client) SubdomainAcmeChallenge 

func (c *Client) SubdomainAcmeChallenge(ctx context.Context, subdomainId openapi_types.UUID, body SubdomainAcmeChallengeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubdomainAcmeChallengeWithBody 

func (c *Client) SubdomainAcmeChallengeWithBody(ctx context.Context, subdomainId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

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

	// GenerateSubdomain request
	GenerateSubdomain(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubdomainAcmeChallenge request with any body
	SubdomainAcmeChallengeWithBody(ctx context.Context, subdomainId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SubdomainAcmeChallenge(ctx context.Context, subdomainId openapi_types.UUID, body SubdomainAcmeChallengeJSONRequestBody, 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) GenerateSubdomainWithResponse 

func (c *ClientWithResponses) GenerateSubdomainWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GenerateSubdomainResponse, error)

GenerateSubdomainWithResponse request returning *GenerateSubdomainResponse

func (*ClientWithResponses) GetOverviewWithResponse 

func (c *ClientWithResponses) GetOverviewWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOverviewResponse, error)

GetOverviewWithResponse request returning *GetOverviewResponse

func (*ClientWithResponses) SubdomainAcmeChallengeWithBodyWithResponse 

func (c *ClientWithResponses) SubdomainAcmeChallengeWithBodyWithResponse(ctx context.Context, subdomainId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubdomainAcmeChallengeResponse, error)

SubdomainAcmeChallengeWithBodyWithResponse request with arbitrary body returning *SubdomainAcmeChallengeResponse

func (*ClientWithResponses) SubdomainAcmeChallengeWithResponse 

func (c *ClientWithResponses) SubdomainAcmeChallengeWithResponse(ctx context.Context, subdomainId openapi_types.UUID, body SubdomainAcmeChallengeJSONRequestBody, reqEditors ...RequestEditorFn) (*SubdomainAcmeChallengeResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetOverview request
	GetOverviewWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOverviewResponse, error)

	// GenerateSubdomain request
	GenerateSubdomainWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GenerateSubdomainResponse, error)

	// SubdomainAcmeChallenge request with any body
	SubdomainAcmeChallengeWithBodyWithResponse(ctx context.Context, subdomainId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubdomainAcmeChallengeResponse, error)

	SubdomainAcmeChallengeWithResponse(ctx context.Context, subdomainId openapi_types.UUID, body SubdomainAcmeChallengeJSONRequestBody, reqEditors ...RequestEditorFn) (*SubdomainAcmeChallengeResponse, error)
}

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

type ErrorResponse 

type ErrorResponse struct {
	Error   string `json:"error"`
	Message string `json:"message"`
}

ErrorResponse defines model for ErrorResponse.

type GenerateSubdomainResponse 

type GenerateSubdomainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NewSubdomainResponse
	JSON429      *ErrorResponse
}

func ParseGenerateSubdomainResponse 

func ParseGenerateSubdomainResponse(rsp *http.Response) (*GenerateSubdomainResponse, error)

ParseGenerateSubdomainResponse parses an HTTP response from a GenerateSubdomainWithResponse call

func (GenerateSubdomainResponse) Status 

func (r GenerateSubdomainResponse) Status() string

Status returns HTTPResponse.Status

func (GenerateSubdomainResponse) StatusCode 

func (r GenerateSubdomainResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOverviewResponse 

type GetOverviewResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *OverviewResponse
}

func ParseGetOverviewResponse 

func ParseGetOverviewResponse(rsp *http.Response) (*GetOverviewResponse, error)

ParseGetOverviewResponse parses an HTTP response from a GetOverviewWithResponse call

func (GetOverviewResponse) Status 

func (r GetOverviewResponse) Status() string

Status returns HTTPResponse.Status

func (GetOverviewResponse) StatusCode 

func (r GetOverviewResponse) 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 NewSubdomainResponse 

type NewSubdomainResponse struct {
	// Domain Allocated domain.
	Domain string `json:"domain"`

	// Id Subdomain ID.
	Id openapi_types.UUID `json:"id"`

	// Token Control Token.
	Token string `json:"token"`
}

NewSubdomainResponse New Subdomain Response.

type OverviewResponse 

type OverviewResponse struct {
	// ClientIp The clients IP address.
	ClientIp string `json:"client_ip"`

	// Version Server Version.
	Version string `json:"version"`
}

OverviewResponse defines model for OverviewResponse.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type SubdomainAcmeChallengeJSONRequestBody 

type SubdomainAcmeChallengeJSONRequestBody = SubdomainAcmeChallengeRequest

SubdomainAcmeChallengeJSONRequestBody defines body for SubdomainAcmeChallenge for application/json ContentType.

type SubdomainAcmeChallengeRequest 

type SubdomainAcmeChallengeRequest struct {
	// Token Control Token.
	Token string `json:"token"`

	// Values ACME Tokens.
	Values []string `json:"values"`
}

SubdomainAcmeChallengeRequest Subdomain ACME Challenge Request.

type SubdomainAcmeChallengeResponse 

type SubdomainAcmeChallengeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSON429      *ErrorResponse
}

func ParseSubdomainAcmeChallengeResponse 

func ParseSubdomainAcmeChallengeResponse(rsp *http.Response) (*SubdomainAcmeChallengeResponse, error)

ParseSubdomainAcmeChallengeResponse parses an HTTP response from a SubdomainAcmeChallengeWithResponse call

func (SubdomainAcmeChallengeResponse) Status 

func (r SubdomainAcmeChallengeResponse) Status() string

Status returns HTTPResponse.Status

func (SubdomainAcmeChallengeResponse) StatusCode 

func (r SubdomainAcmeChallengeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.