oapi

package
v0.0.0-...-aa36cb2 Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2024 License: AGPL-3.0 Imports: 18 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func NewCreateAppRequest

func NewCreateAppRequest(server string, appId Id, body CreateAppJSONRequestBody) (*http.Request, error)

NewCreateAppRequest calls the generic CreateApp builder with application/json body

func NewCreateAppRequestWithBody

func NewCreateAppRequestWithBody(server string, appId Id, contentType string, body io.Reader) (*http.Request, error)

NewCreateAppRequestWithBody generates requests for CreateApp with any type of body

func NewCreateEnvRequest

func NewCreateEnvRequest(server string, envId Id, body CreateEnvJSONRequestBody) (*http.Request, error)

NewCreateEnvRequest calls the generic CreateEnv builder with application/json body

func NewCreateEnvRequestWithBody

func NewCreateEnvRequestWithBody(server string, envId Id, contentType string, body io.Reader) (*http.Request, error)

NewCreateEnvRequestWithBody generates requests for CreateEnv with any type of body

func NewDeleteAppRequest

func NewDeleteAppRequest(server string, appId Id) (*http.Request, error)

NewDeleteAppRequest generates requests for DeleteApp

func NewDeleteEnvRequest

func NewDeleteEnvRequest(server string, envId Id) (*http.Request, error)

NewDeleteEnvRequest generates requests for DeleteEnv

func NewGetAppRequest

func NewGetAppRequest(server string, appId Id) (*http.Request, error)

NewGetAppRequest generates requests for GetApp

func NewGetAppsRequest

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

NewGetAppsRequest generates requests for GetApps

func NewGetEnvRequest

func NewGetEnvRequest(server string, envId Id) (*http.Request, error)

NewGetEnvRequest generates requests for GetEnv

func NewGetEnvsRequest

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

NewGetEnvsRequest generates requests for GetEnvs

func NewUpRequestWithBody

func NewUpRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpRequestWithBody generates requests for Up with any type of body

func NewWhoAmIRequest

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

NewWhoAmIRequest generates requests for WhoAmI

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type App

type App struct {
	CreatedAt time.Time `json:"created_at"`

	// CreatorId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	CreatorId Id `json:"creator_id"`

	// Id A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	Id   Id     `json:"id"`
	Name string `json:"name"`

	// TeamId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	TeamId    Id        `json:"team_id"`
	UpdatedAt time.Time `json:"updated_at"`
}

App defines model for App.

type Apps

type Apps = []App

Apps defines model for Apps.

type BadRequest

type BadRequest = Error

BadRequest defines model for BadRequest.

type BadRequestJSONResponse

type BadRequestJSONResponse Error

type ChiServerOptions

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

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) CreateApp

func (c *Client) CreateApp(ctx context.Context, appId Id, body CreateAppJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateAppWithBody

func (c *Client) CreateAppWithBody(ctx context.Context, appId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnv

func (c *Client) CreateEnv(ctx context.Context, envId Id, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateEnvWithBody

func (c *Client) CreateEnvWithBody(ctx context.Context, envId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteApp

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

func (*Client) DeleteEnv

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

func (*Client) GetApp

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

func (*Client) GetApps

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

func (*Client) GetEnv

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

func (*Client) GetEnvs

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

func (*Client) UpWithBody

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

func (*Client) WhoAmI

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

type ClientInterface

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

	// DeleteApp request
	DeleteApp(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApp request
	GetApp(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateAppWithBody request with any body
	CreateAppWithBody(ctx context.Context, appId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateApp(ctx context.Context, appId Id, body CreateAppJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// DeleteEnv request
	DeleteEnv(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEnv request
	GetEnv(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateEnvWithBody request with any body
	CreateEnvWithBody(ctx context.Context, envId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateEnv(ctx context.Context, envId Id, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpWithBody request with any body
	UpWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// WhoAmI request
	WhoAmI(ctx context.Context, 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) CreateAppWithBodyWithResponse

func (c *ClientWithResponses) CreateAppWithBodyWithResponse(ctx context.Context, appId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAppResponse, error)

CreateAppWithBodyWithResponse request with arbitrary body returning *CreateAppResponse

func (*ClientWithResponses) CreateAppWithResponse

func (c *ClientWithResponses) CreateAppWithResponse(ctx context.Context, appId Id, body CreateAppJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAppResponse, error)

func (*ClientWithResponses) CreateEnvWithBodyWithResponse

func (c *ClientWithResponses) CreateEnvWithBodyWithResponse(ctx context.Context, envId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResponse, error)

CreateEnvWithBodyWithResponse request with arbitrary body returning *CreateEnvResponse

func (*ClientWithResponses) CreateEnvWithResponse

func (c *ClientWithResponses) CreateEnvWithResponse(ctx context.Context, envId Id, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResponse, error)

func (*ClientWithResponses) DeleteAppWithResponse

func (c *ClientWithResponses) DeleteAppWithResponse(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*DeleteAppResponse, error)

DeleteAppWithResponse request returning *DeleteAppResponse

func (*ClientWithResponses) DeleteEnvWithResponse

func (c *ClientWithResponses) DeleteEnvWithResponse(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*DeleteEnvResponse, error)

DeleteEnvWithResponse request returning *DeleteEnvResponse

func (*ClientWithResponses) GetAppWithResponse

func (c *ClientWithResponses) GetAppWithResponse(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*GetAppResponse, error)

GetAppWithResponse request returning *GetAppResponse

func (*ClientWithResponses) GetAppsWithResponse

func (c *ClientWithResponses) GetAppsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAppsResponse, error)

GetAppsWithResponse request returning *GetAppsResponse

func (*ClientWithResponses) GetEnvWithResponse

func (c *ClientWithResponses) GetEnvWithResponse(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*GetEnvResponse, error)

GetEnvWithResponse request returning *GetEnvResponse

func (*ClientWithResponses) GetEnvsWithResponse

func (c *ClientWithResponses) GetEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEnvsResponse, error)

GetEnvsWithResponse request returning *GetEnvsResponse

func (*ClientWithResponses) UpWithBodyWithResponse

func (c *ClientWithResponses) UpWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpResponse, error)

UpWithBodyWithResponse request with arbitrary body returning *UpResponse

func (*ClientWithResponses) WhoAmIWithResponse

func (c *ClientWithResponses) WhoAmIWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*WhoAmIResponse, error)

WhoAmIWithResponse request returning *WhoAmIResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetAppsWithResponse request
	GetAppsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetAppsResponse, error)

	// DeleteAppWithResponse request
	DeleteAppWithResponse(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*DeleteAppResponse, error)

	// GetAppWithResponse request
	GetAppWithResponse(ctx context.Context, appId Id, reqEditors ...RequestEditorFn) (*GetAppResponse, error)

	// CreateAppWithBodyWithResponse request with any body
	CreateAppWithBodyWithResponse(ctx context.Context, appId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAppResponse, error)

	CreateAppWithResponse(ctx context.Context, appId Id, body CreateAppJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAppResponse, error)

	// GetEnvsWithResponse request
	GetEnvsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetEnvsResponse, error)

	// DeleteEnvWithResponse request
	DeleteEnvWithResponse(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*DeleteEnvResponse, error)

	// GetEnvWithResponse request
	GetEnvWithResponse(ctx context.Context, envId Id, reqEditors ...RequestEditorFn) (*GetEnvResponse, error)

	// CreateEnvWithBodyWithResponse request with any body
	CreateEnvWithBodyWithResponse(ctx context.Context, envId Id, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateEnvResponse, error)

	CreateEnvWithResponse(ctx context.Context, envId Id, body CreateEnvJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateEnvResponse, error)

	// UpWithBodyWithResponse request with any body
	UpWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpResponse, error)

	// WhoAmIWithResponse request
	WhoAmIWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*WhoAmIResponse, error)
}

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

type CreateApp201JSONResponse

type CreateApp201JSONResponse App

func (CreateApp201JSONResponse) VisitCreateAppResponse

func (response CreateApp201JSONResponse) VisitCreateAppResponse(w http.ResponseWriter) error

type CreateApp400JSONResponse

type CreateApp400JSONResponse struct{ BadRequestJSONResponse }

func (CreateApp400JSONResponse) VisitCreateAppResponse

func (response CreateApp400JSONResponse) VisitCreateAppResponse(w http.ResponseWriter) error

type CreateApp500JSONResponse

type CreateApp500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (CreateApp500JSONResponse) VisitCreateAppResponse

func (response CreateApp500JSONResponse) VisitCreateAppResponse(w http.ResponseWriter) error

type CreateAppJSONBody

type CreateAppJSONBody struct {
	Name string `json:"name"`
}

CreateAppJSONBody defines parameters for CreateApp.

type CreateAppJSONRequestBody

type CreateAppJSONRequestBody CreateAppJSONBody

CreateAppJSONRequestBody defines body for CreateApp for application/json ContentType.

type CreateAppRequestObject

type CreateAppRequestObject struct {
	AppId Id `json:"appId"`
	Body  *CreateAppJSONRequestBody
}

type CreateAppResponse

type CreateAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *App
	JSON400      *BadRequest
	JSON500      *InternalServerError
}

func ParseCreateAppResponse

func ParseCreateAppResponse(rsp *http.Response) (*CreateAppResponse, error)

ParseCreateAppResponse parses an HTTP response from a CreateAppWithResponse call

func (CreateAppResponse) Status

func (r CreateAppResponse) Status() string

Status returns HTTPResponse.Status

func (CreateAppResponse) StatusCode

func (r CreateAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateAppResponseObject

type CreateAppResponseObject interface {
	VisitCreateAppResponse(w http.ResponseWriter) error
}

type CreateEnv201JSONResponse

type CreateEnv201JSONResponse Env

func (CreateEnv201JSONResponse) VisitCreateEnvResponse

func (response CreateEnv201JSONResponse) VisitCreateEnvResponse(w http.ResponseWriter) error

type CreateEnv400JSONResponse

type CreateEnv400JSONResponse struct{ BadRequestJSONResponse }

func (CreateEnv400JSONResponse) VisitCreateEnvResponse

func (response CreateEnv400JSONResponse) VisitCreateEnvResponse(w http.ResponseWriter) error

type CreateEnv500JSONResponse

type CreateEnv500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (CreateEnv500JSONResponse) VisitCreateEnvResponse

func (response CreateEnv500JSONResponse) VisitCreateEnvResponse(w http.ResponseWriter) error

type CreateEnvJSONBody

type CreateEnvJSONBody struct {
	Name string `json:"name"`
}

CreateEnvJSONBody defines parameters for CreateEnv.

type CreateEnvJSONRequestBody

type CreateEnvJSONRequestBody CreateEnvJSONBody

CreateEnvJSONRequestBody defines body for CreateEnv for application/json ContentType.

type CreateEnvRequestObject

type CreateEnvRequestObject struct {
	EnvId Id `json:"envId"`
	Body  *CreateEnvJSONRequestBody
}

type CreateEnvResponse

type CreateEnvResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Env
	JSON400      *BadRequest
	JSON500      *InternalServerError
}

func ParseCreateEnvResponse

func ParseCreateEnvResponse(rsp *http.Response) (*CreateEnvResponse, error)

ParseCreateEnvResponse parses an HTTP response from a CreateEnvWithResponse call

func (CreateEnvResponse) Status

func (r CreateEnvResponse) Status() string

Status returns HTTPResponse.Status

func (CreateEnvResponse) StatusCode

func (r CreateEnvResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateEnvResponseObject

type CreateEnvResponseObject interface {
	VisitCreateEnvResponse(w http.ResponseWriter) error
}

type DeleteApp204Response

type DeleteApp204Response struct {
}

func (DeleteApp204Response) VisitDeleteAppResponse

func (response DeleteApp204Response) VisitDeleteAppResponse(w http.ResponseWriter) error

type DeleteApp404JSONResponse

type DeleteApp404JSONResponse struct{ NotFoundJSONResponse }

func (DeleteApp404JSONResponse) VisitDeleteAppResponse

func (response DeleteApp404JSONResponse) VisitDeleteAppResponse(w http.ResponseWriter) error

type DeleteApp500JSONResponse

type DeleteApp500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (DeleteApp500JSONResponse) VisitDeleteAppResponse

func (response DeleteApp500JSONResponse) VisitDeleteAppResponse(w http.ResponseWriter) error

type DeleteAppRequestObject

type DeleteAppRequestObject struct {
	AppId Id `json:"appId"`
}

type DeleteAppResponse

type DeleteAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseDeleteAppResponse

func ParseDeleteAppResponse(rsp *http.Response) (*DeleteAppResponse, error)

ParseDeleteAppResponse parses an HTTP response from a DeleteAppWithResponse call

func (DeleteAppResponse) Status

func (r DeleteAppResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteAppResponse) StatusCode

func (r DeleteAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteAppResponseObject

type DeleteAppResponseObject interface {
	VisitDeleteAppResponse(w http.ResponseWriter) error
}

type DeleteEnv204Response

type DeleteEnv204Response struct {
}

func (DeleteEnv204Response) VisitDeleteEnvResponse

func (response DeleteEnv204Response) VisitDeleteEnvResponse(w http.ResponseWriter) error

type DeleteEnv404JSONResponse

type DeleteEnv404JSONResponse struct{ NotFoundJSONResponse }

func (DeleteEnv404JSONResponse) VisitDeleteEnvResponse

func (response DeleteEnv404JSONResponse) VisitDeleteEnvResponse(w http.ResponseWriter) error

type DeleteEnv500JSONResponse

type DeleteEnv500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (DeleteEnv500JSONResponse) VisitDeleteEnvResponse

func (response DeleteEnv500JSONResponse) VisitDeleteEnvResponse(w http.ResponseWriter) error

type DeleteEnvRequestObject

type DeleteEnvRequestObject struct {
	EnvId Id `json:"envId"`
}

type DeleteEnvResponse

type DeleteEnvResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseDeleteEnvResponse

func ParseDeleteEnvResponse(rsp *http.Response) (*DeleteEnvResponse, error)

ParseDeleteEnvResponse parses an HTTP response from a DeleteEnvWithResponse call

func (DeleteEnvResponse) Status

func (r DeleteEnvResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteEnvResponse) StatusCode

func (r DeleteEnvResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteEnvResponseObject

type DeleteEnvResponseObject interface {
	VisitDeleteEnvResponse(w http.ResponseWriter) error
}

type Env

type Env struct {
	CreatedAt time.Time `json:"created_at"`

	// Id A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	Id        Id        `json:"id"`
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at"`
}

Env defines model for Env.

type Envs

type Envs = []Env

Envs defines model for Envs.

type Error

type Error struct {
	Code  *string `json:"code,omitempty"`
	Error string  `json:"error"`
}

Error defines model for Error.

type GetApp200JSONResponse

type GetApp200JSONResponse App

func (GetApp200JSONResponse) VisitGetAppResponse

func (response GetApp200JSONResponse) VisitGetAppResponse(w http.ResponseWriter) error

type GetApp404JSONResponse

type GetApp404JSONResponse struct{ NotFoundJSONResponse }

func (GetApp404JSONResponse) VisitGetAppResponse

func (response GetApp404JSONResponse) VisitGetAppResponse(w http.ResponseWriter) error

type GetApp500JSONResponse

type GetApp500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetApp500JSONResponse) VisitGetAppResponse

func (response GetApp500JSONResponse) VisitGetAppResponse(w http.ResponseWriter) error

type GetAppRequestObject

type GetAppRequestObject struct {
	AppId Id `json:"appId"`
}

type GetAppResponse

type GetAppResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *App
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetAppResponse

func ParseGetAppResponse(rsp *http.Response) (*GetAppResponse, error)

ParseGetAppResponse parses an HTTP response from a GetAppWithResponse call

func (GetAppResponse) Status

func (r GetAppResponse) Status() string

Status returns HTTPResponse.Status

func (GetAppResponse) StatusCode

func (r GetAppResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAppResponseObject

type GetAppResponseObject interface {
	VisitGetAppResponse(w http.ResponseWriter) error
}

type GetApps200JSONResponse

type GetApps200JSONResponse Apps

func (GetApps200JSONResponse) VisitGetAppsResponse

func (response GetApps200JSONResponse) VisitGetAppsResponse(w http.ResponseWriter) error

type GetApps500JSONResponse

type GetApps500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetApps500JSONResponse) VisitGetAppsResponse

func (response GetApps500JSONResponse) VisitGetAppsResponse(w http.ResponseWriter) error

type GetAppsRequestObject

type GetAppsRequestObject struct {
}

type GetAppsResponse

type GetAppsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Apps
	JSON500      *InternalServerError
}

func ParseGetAppsResponse

func ParseGetAppsResponse(rsp *http.Response) (*GetAppsResponse, error)

ParseGetAppsResponse parses an HTTP response from a GetAppsWithResponse call

func (GetAppsResponse) Status

func (r GetAppsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAppsResponse) StatusCode

func (r GetAppsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAppsResponseObject

type GetAppsResponseObject interface {
	VisitGetAppsResponse(w http.ResponseWriter) error
}

type GetEnv200JSONResponse

type GetEnv200JSONResponse Env

func (GetEnv200JSONResponse) VisitGetEnvResponse

func (response GetEnv200JSONResponse) VisitGetEnvResponse(w http.ResponseWriter) error

type GetEnv404JSONResponse

type GetEnv404JSONResponse struct{ NotFoundJSONResponse }

func (GetEnv404JSONResponse) VisitGetEnvResponse

func (response GetEnv404JSONResponse) VisitGetEnvResponse(w http.ResponseWriter) error

type GetEnv500JSONResponse

type GetEnv500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetEnv500JSONResponse) VisitGetEnvResponse

func (response GetEnv500JSONResponse) VisitGetEnvResponse(w http.ResponseWriter) error

type GetEnvRequestObject

type GetEnvRequestObject struct {
	EnvId Id `json:"envId"`
}

type GetEnvResponse

type GetEnvResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Env
	JSON404      *NotFound
	JSON500      *InternalServerError
}

func ParseGetEnvResponse

func ParseGetEnvResponse(rsp *http.Response) (*GetEnvResponse, error)

ParseGetEnvResponse parses an HTTP response from a GetEnvWithResponse call

func (GetEnvResponse) Status

func (r GetEnvResponse) Status() string

Status returns HTTPResponse.Status

func (GetEnvResponse) StatusCode

func (r GetEnvResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvResponseObject

type GetEnvResponseObject interface {
	VisitGetEnvResponse(w http.ResponseWriter) error
}

type GetEnvs200JSONResponse

type GetEnvs200JSONResponse Envs

func (GetEnvs200JSONResponse) VisitGetEnvsResponse

func (response GetEnvs200JSONResponse) VisitGetEnvsResponse(w http.ResponseWriter) error

type GetEnvs500JSONResponse

type GetEnvs500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (GetEnvs500JSONResponse) VisitGetEnvsResponse

func (response GetEnvs500JSONResponse) VisitGetEnvsResponse(w http.ResponseWriter) error

type GetEnvsRequestObject

type GetEnvsRequestObject struct {
}

type GetEnvsResponse

type GetEnvsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Envs
	JSON500      *InternalServerError
}

func ParseGetEnvsResponse

func ParseGetEnvsResponse(rsp *http.Response) (*GetEnvsResponse, error)

ParseGetEnvsResponse parses an HTTP response from a GetEnvsWithResponse call

func (GetEnvsResponse) Status

func (r GetEnvsResponse) Status() string

Status returns HTTPResponse.Status

func (GetEnvsResponse) StatusCode

func (r GetEnvsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEnvsResponseObject

type GetEnvsResponseObject interface {
	VisitGetEnvsResponse(w http.ResponseWriter) error
}

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Id

type Id = string

Id A string with a prefix, underscore, and 26 alphanumeric characters (type ID)

type InternalServerError

type InternalServerError = Error

InternalServerError defines model for InternalServerError.

type InternalServerErrorJSONResponse

type InternalServerErrorJSONResponse Error

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type NotFound

type NotFound = Error

NotFound defines model for NotFound.

type NotFoundJSONResponse

type NotFoundJSONResponse Error

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type ServerInterface

type ServerInterface interface {

	// (GET /api/apps)
	GetApps(w http.ResponseWriter, r *http.Request)

	// (DELETE /api/apps/{appId})
	DeleteApp(w http.ResponseWriter, r *http.Request, appId Id)

	// (GET /api/apps/{appId})
	GetApp(w http.ResponseWriter, r *http.Request, appId Id)

	// (PUT /api/apps/{appId})
	CreateApp(w http.ResponseWriter, r *http.Request, appId Id)

	// (GET /api/envs)
	GetEnvs(w http.ResponseWriter, r *http.Request)

	// (DELETE /api/envs/{envId})
	DeleteEnv(w http.ResponseWriter, r *http.Request, envId Id)

	// (GET /api/envs/{envId})
	GetEnv(w http.ResponseWriter, r *http.Request, envId Id)

	// (PUT /api/envs/{envId})
	CreateEnv(w http.ResponseWriter, r *http.Request, envId Id)

	// (POST /api/up)
	Up(w http.ResponseWriter, r *http.Request)

	// (GET /api/whoami)
	WhoAmI(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

func NewStrictHandlerWithOptions

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CreateApp

func (siw *ServerInterfaceWrapper) CreateApp(w http.ResponseWriter, r *http.Request)

CreateApp operation middleware

func (*ServerInterfaceWrapper) CreateEnv

func (siw *ServerInterfaceWrapper) CreateEnv(w http.ResponseWriter, r *http.Request)

CreateEnv operation middleware

func (*ServerInterfaceWrapper) DeleteApp

func (siw *ServerInterfaceWrapper) DeleteApp(w http.ResponseWriter, r *http.Request)

DeleteApp operation middleware

func (*ServerInterfaceWrapper) DeleteEnv

func (siw *ServerInterfaceWrapper) DeleteEnv(w http.ResponseWriter, r *http.Request)

DeleteEnv operation middleware

func (*ServerInterfaceWrapper) GetApp

GetApp operation middleware

func (*ServerInterfaceWrapper) GetApps

GetApps operation middleware

func (*ServerInterfaceWrapper) GetEnv

GetEnv operation middleware

func (*ServerInterfaceWrapper) GetEnvs

GetEnvs operation middleware

func (*ServerInterfaceWrapper) Up

Up operation middleware

func (*ServerInterfaceWrapper) WhoAmI

WhoAmI operation middleware

type StrictHTTPServerOptions

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictServerInterface

type StrictServerInterface interface {

	// (GET /api/apps)
	GetApps(ctx context.Context, request GetAppsRequestObject) (GetAppsResponseObject, error)

	// (DELETE /api/apps/{appId})
	DeleteApp(ctx context.Context, request DeleteAppRequestObject) (DeleteAppResponseObject, error)

	// (GET /api/apps/{appId})
	GetApp(ctx context.Context, request GetAppRequestObject) (GetAppResponseObject, error)

	// (PUT /api/apps/{appId})
	CreateApp(ctx context.Context, request CreateAppRequestObject) (CreateAppResponseObject, error)

	// (GET /api/envs)
	GetEnvs(ctx context.Context, request GetEnvsRequestObject) (GetEnvsResponseObject, error)

	// (DELETE /api/envs/{envId})
	DeleteEnv(ctx context.Context, request DeleteEnvRequestObject) (DeleteEnvResponseObject, error)

	// (GET /api/envs/{envId})
	GetEnv(ctx context.Context, request GetEnvRequestObject) (GetEnvResponseObject, error)

	// (PUT /api/envs/{envId})
	CreateEnv(ctx context.Context, request CreateEnvRequestObject) (CreateEnvResponseObject, error)

	// (POST /api/up)
	Up(ctx context.Context, request UpRequestObject) (UpResponseObject, error)

	// (GET /api/whoami)
	WhoAmI(ctx context.Context, request WhoAmIRequestObject) (WhoAmIResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented

type Unimplemented struct{}

func (Unimplemented) CreateApp

func (_ Unimplemented) CreateApp(w http.ResponseWriter, r *http.Request, appId Id)

(PUT /api/apps/{appId})

func (Unimplemented) CreateEnv

func (_ Unimplemented) CreateEnv(w http.ResponseWriter, r *http.Request, envId Id)

(PUT /api/envs/{envId})

func (Unimplemented) DeleteApp

func (_ Unimplemented) DeleteApp(w http.ResponseWriter, r *http.Request, appId Id)

(DELETE /api/apps/{appId})

func (Unimplemented) DeleteEnv

func (_ Unimplemented) DeleteEnv(w http.ResponseWriter, r *http.Request, envId Id)

(DELETE /api/envs/{envId})

func (Unimplemented) GetApp

func (_ Unimplemented) GetApp(w http.ResponseWriter, r *http.Request, appId Id)

(GET /api/apps/{appId})

func (Unimplemented) GetApps

func (_ Unimplemented) GetApps(w http.ResponseWriter, r *http.Request)

(GET /api/apps)

func (Unimplemented) GetEnv

func (_ Unimplemented) GetEnv(w http.ResponseWriter, r *http.Request, envId Id)

(GET /api/envs/{envId})

func (Unimplemented) GetEnvs

func (_ Unimplemented) GetEnvs(w http.ResponseWriter, r *http.Request)

(GET /api/envs)

func (Unimplemented) Up

(POST /api/up)

func (Unimplemented) WhoAmI

func (_ Unimplemented) WhoAmI(w http.ResponseWriter, r *http.Request)

(GET /api/whoami)

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type Up200TexteventStreamResponse

type Up200TexteventStreamResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (Up200TexteventStreamResponse) VisitUpResponse

func (response Up200TexteventStreamResponse) VisitUpResponse(w http.ResponseWriter) error

type Up400JSONResponse

type Up400JSONResponse struct{ BadRequestJSONResponse }

func (Up400JSONResponse) VisitUpResponse

func (response Up400JSONResponse) VisitUpResponse(w http.ResponseWriter) error

type Up500JSONResponse

type Up500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (Up500JSONResponse) VisitUpResponse

func (response Up500JSONResponse) VisitUpResponse(w http.ResponseWriter) error

type UpLog

type UpLog struct {
	// Message Content of the log.
	Message *string `json:"message,omitempty"`

	// Time Timestamp of the log.
	Time *time.Time `json:"time,omitempty"`
}

UpLog defines model for UpLog.

type UpMultipartBody

type UpMultipartBody struct {
	// AppId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	AppId   Id                 `json:"app_id"`
	Archive openapi_types.File `json:"archive"`

	// EnvId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	EnvId Id `json:"env_id"`
}

UpMultipartBody defines parameters for Up.

type UpMultipartRequestBody

type UpMultipartRequestBody UpMultipartBody

UpMultipartRequestBody defines body for Up for multipart/form-data ContentType.

type UpRequestObject

type UpRequestObject struct {
	Body *multipart.Reader
}

type UpResponse

type UpResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *BadRequest
	JSON500      *InternalServerError
}

func ParseUpResponse

func ParseUpResponse(rsp *http.Response) (*UpResponse, error)

ParseUpResponse parses an HTTP response from a UpWithResponse call

func (UpResponse) Status

func (r UpResponse) Status() string

Status returns HTTPResponse.Status

func (UpResponse) StatusCode

func (r UpResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpResponseObject

type UpResponseObject interface {
	VisitUpResponse(w http.ResponseWriter) error
}

type WhoAmI

type WhoAmI struct {
	CreatedAt time.Time `json:"created_at"`

	// TeamId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	TeamId   Id     `json:"team_id"`
	TeamName string `json:"team_name"`

	// TokenId A string with a prefix, underscore, and 26 alphanumeric characters (type ID)
	TokenId Id `json:"token_id"`
}

WhoAmI defines model for WhoAmI.

type WhoAmI200JSONResponse

type WhoAmI200JSONResponse WhoAmI

func (WhoAmI200JSONResponse) VisitWhoAmIResponse

func (response WhoAmI200JSONResponse) VisitWhoAmIResponse(w http.ResponseWriter) error

type WhoAmI500JSONResponse

type WhoAmI500JSONResponse struct {
	InternalServerErrorJSONResponse
}

func (WhoAmI500JSONResponse) VisitWhoAmIResponse

func (response WhoAmI500JSONResponse) VisitWhoAmIResponse(w http.ResponseWriter) error

type WhoAmIRequestObject

type WhoAmIRequestObject struct {
}

type WhoAmIResponse

type WhoAmIResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WhoAmI
	JSON500      *InternalServerError
}

func ParseWhoAmIResponse

func ParseWhoAmIResponse(rsp *http.Response) (*WhoAmIResponse, error)

ParseWhoAmIResponse parses an HTTP response from a WhoAmIWithResponse call

func (WhoAmIResponse) Status

func (r WhoAmIResponse) Status() string

Status returns HTTPResponse.Status

func (WhoAmIResponse) StatusCode

func (r WhoAmIResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type WhoAmIResponseObject

type WhoAmIResponseObject interface {
	VisitWhoAmIResponse(w http.ResponseWriter) error
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL