app

package
v0.1.3 Latest Latest
Warning

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

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 12 Imported by: 1

Documentation

Overview

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

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

Index

Constants

View Source
const (
	TokenScopes = "Token.Scopes"
)

Variables

This section is empty.

Functions

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 NewPostAppsOperationsNextRequest

func NewPostAppsOperationsNextRequest(server string, body PostAppsOperationsNextJSONRequestBody) (*http.Request, error)

NewPostAppsOperationsNextRequest calls the generic PostAppsOperationsNext builder with application/json body

func NewPostAppsOperationsNextRequestWithBody

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

NewPostAppsOperationsNextRequestWithBody generates requests for PostAppsOperationsNext with any type of body

func NewPostAppsOperationsReportRequest

func NewPostAppsOperationsReportRequest(server string, body PostAppsOperationsReportJSONRequestBody) (*http.Request, error)

NewPostAppsOperationsReportRequest calls the generic PostAppsOperationsReport builder with application/json body

func NewPostAppsOperationsReportRequestWithBody

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

NewPostAppsOperationsReportRequestWithBody generates requests for PostAppsOperationsReport with any type of body

func NewPostAppsVersionConnectRequest

func NewPostAppsVersionConnectRequest(server string, body PostAppsVersionConnectJSONRequestBody) (*http.Request, error)

NewPostAppsVersionConnectRequest calls the generic PostAppsVersionConnect builder with application/json body

func NewPostAppsVersionConnectRequestWithBody

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

NewPostAppsVersionConnectRequestWithBody generates requests for PostAppsVersionConnect with any type of body

func NewPostAppsVersionsHealthRequest

func NewPostAppsVersionsHealthRequest(server string, body PostAppsVersionsHealthJSONRequestBody) (*http.Request, error)

NewPostAppsVersionsHealthRequest calls the generic PostAppsVersionsHealth builder with application/json body

func NewPostAppsVersionsHealthRequestWithBody

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

NewPostAppsVersionsHealthRequestWithBody generates requests for PostAppsVersionsHealth with any type of body

Types

type ActionDefinition

type ActionDefinition struct {
	// Description A description of the action.
	Description *string `json:"description,omitempty"`

	// DisplayName The display name of the action.
	DisplayName *string `json:"display_name,omitempty"`

	// InputJsonSchema JSON schema defining the input for the action.
	InputJsonSchema *map[string]interface{} `json:"input_json_schema,omitempty"`

	// Name The unique name of the action.
	Name *string `json:"name,omitempty"`

	// OutputJsonSchema JSON schema defining the output for the action.
	OutputJsonSchema *map[string]interface{} `json:"output_json_schema,omitempty"`
}

ActionDefinition defines model for ActionDefinition.

type AppHealthReportItem

type AppHealthReportItem struct {
	// Message A message providing additional information.
	Message *string `json:"message,omitempty"`

	// Status The status of the health check.
	Status AppHealthReportItemStatus `json:"status"`

	// Type The resource type being reported.
	Type string `json:"type"`
}

AppHealthReportItem defines model for AppHealthReportItem.

type AppHealthReportItemStatus

type AppHealthReportItemStatus string

AppHealthReportItemStatus The status of the health check.

const (
	Degraded  AppHealthReportItemStatus = "degraded"
	Disrupted AppHealthReportItemStatus = "disrupted"
	Healthy   AppHealthReportItemStatus = "healthy"
)

Defines values for AppHealthReportItemStatus.

type AppHealthReportRequest

type AppHealthReportRequest struct {
	// AppId The unique identifier of the application.
	AppId string `json:"app_id"`

	// HealthReports Health check reports for the application.
	HealthReports []AppHealthReportItem `json:"health_reports"`

	// Version The version of the application.
	Version string `json:"version"`
}

AppHealthReportRequest defines model for AppHealthReportRequest.

type AppRequest

type AppRequest struct {
	// AppId The unique identifier of the application.
	AppId string `json:"app_id"`

	// Version The version of the application.
	Version string `json:"version"`
}

AppRequest defines model for AppRequest.

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

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

func (*Client) PostAppsOperationsNextWithBody

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

func (*Client) PostAppsOperationsReport

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

func (*Client) PostAppsOperationsReportWithBody

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

func (*Client) PostAppsVersionConnect

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

func (*Client) PostAppsVersionConnectWithBody

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

func (*Client) PostAppsVersionsHealth

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

func (*Client) PostAppsVersionsHealthWithBody

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

type ClientInterface

type ClientInterface interface {
	// PostAppsOperationsNextWithBody request with any body
	PostAppsOperationsNextWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostAppsOperationsNext(ctx context.Context, body PostAppsOperationsNextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostAppsOperationsReport(ctx context.Context, body PostAppsOperationsReportJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostAppsVersionConnect(ctx context.Context, body PostAppsVersionConnectJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	PostAppsVersionsHealth(ctx context.Context, body PostAppsVersionsHealthJSONRequestBody, 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) PostAppsOperationsNextWithBodyWithResponse

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

PostAppsOperationsNextWithBodyWithResponse request with arbitrary body returning *PostAppsOperationsNextResponse

func (*ClientWithResponses) PostAppsOperationsNextWithResponse

func (c *ClientWithResponses) PostAppsOperationsNextWithResponse(ctx context.Context, body PostAppsOperationsNextJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsOperationsNextResponse, error)

func (*ClientWithResponses) PostAppsOperationsReportWithBodyWithResponse

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

PostAppsOperationsReportWithBodyWithResponse request with arbitrary body returning *PostAppsOperationsReportResponse

func (*ClientWithResponses) PostAppsOperationsReportWithResponse

func (c *ClientWithResponses) PostAppsOperationsReportWithResponse(ctx context.Context, body PostAppsOperationsReportJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsOperationsReportResponse, error)

func (*ClientWithResponses) PostAppsVersionConnectWithBodyWithResponse

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

PostAppsVersionConnectWithBodyWithResponse request with arbitrary body returning *PostAppsVersionConnectResponse

func (*ClientWithResponses) PostAppsVersionConnectWithResponse

func (c *ClientWithResponses) PostAppsVersionConnectWithResponse(ctx context.Context, body PostAppsVersionConnectJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsVersionConnectResponse, error)

func (*ClientWithResponses) PostAppsVersionsHealthWithBodyWithResponse

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

PostAppsVersionsHealthWithBodyWithResponse request with arbitrary body returning *PostAppsVersionsHealthResponse

func (*ClientWithResponses) PostAppsVersionsHealthWithResponse

func (c *ClientWithResponses) PostAppsVersionsHealthWithResponse(ctx context.Context, body PostAppsVersionsHealthJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsVersionsHealthResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostAppsOperationsNextWithBodyWithResponse request with any body
	PostAppsOperationsNextWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostAppsOperationsNextResponse, error)

	PostAppsOperationsNextWithResponse(ctx context.Context, body PostAppsOperationsNextJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsOperationsNextResponse, error)

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

	PostAppsOperationsReportWithResponse(ctx context.Context, body PostAppsOperationsReportJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsOperationsReportResponse, error)

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

	PostAppsVersionConnectWithResponse(ctx context.Context, body PostAppsVersionConnectJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsVersionConnectResponse, error)

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

	PostAppsVersionsHealthWithResponse(ctx context.Context, body PostAppsVersionsHealthJSONRequestBody, reqEditors ...RequestEditorFn) (*PostAppsVersionsHealthResponse, error)
}

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

type EnvironmentVariable added in v0.1.2

type EnvironmentVariable struct {
	// Name The name of the environment variable.
	Name string `json:"name"`

	// Type The type of environment variable.
	Type EnvironmentVariableType `json:"type"`

	// Value The value of the environment variable.
	Value string `json:"value"`
}

EnvironmentVariable defines model for EnvironmentVariable.

type EnvironmentVariableType added in v0.1.2

type EnvironmentVariableType string

EnvironmentVariableType The type of environment variable.

const (
	Certificate EnvironmentVariableType = "certificate"
	PrivateKey  EnvironmentVariableType = "private_key"
	PublicKey   EnvironmentVariableType = "public_key"
	Secret      EnvironmentVariableType = "secret"
	Variable    EnvironmentVariableType = "variable"
)

Defines values for EnvironmentVariableType.

type ErrorResponse

type ErrorResponse struct {
	// Error Error message detailing the failure.
	Error string `json:"error"`

	// Status Always "error" for this schema.
	Status ErrorResponseStatus `json:"status"`
}

ErrorResponse defines model for ErrorResponse.

type ErrorResponseStatus

type ErrorResponseStatus string

ErrorResponseStatus Always "error" for this schema.

const (
	ErrorResponseStatusError ErrorResponseStatus = "error"
)

Defines values for ErrorResponseStatus.

type ExecuteResourceActionRequest

type ExecuteResourceActionRequest struct {
	// Action The action to perform on the resource.
	Action string `json:"action"`

	// EnvironmentVariables The environment variables for the operation.
	EnvironmentVariables *[]EnvironmentVariable `json:"environment_variables,omitempty"`

	// Input The input parameters for the operation.
	Input *map[string]interface{} `json:"input,omitempty"`

	// Metadata Metadata associated with the resource operation.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// RequestType The type of request.
	RequestType string   `json:"request_type"`
	Resource    Resource `json:"resource"`
}

ExecuteResourceActionRequest defines model for ExecuteResourceActionRequest.

type ExecuteResourceActionResponse

type ExecuteResourceActionResponse struct {
	// Output The output of the action.
	Output map[string]interface{} `json:"output"`

	// ResponseType The type of response.
	ResponseType string `json:"response_type"`
}

ExecuteResourceActionResponse defines model for ExecuteResourceActionResponse.

type ExecuteResourceOperationRequest

type ExecuteResourceOperationRequest struct {
	// EnvironmentVariables The environment variables for the operation.
	EnvironmentVariables *[]EnvironmentVariable `json:"environment_variables,omitempty"`

	// Input The input parameters for the operation.
	Input *map[string]interface{} `json:"input,omitempty"`

	// Metadata Metadata associated with the resource operation.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// Operation The operation to perform on the resource.
	Operation ExecuteResourceOperationRequestOperation `json:"operation"`

	// RequestType The type of request.
	RequestType string   `json:"request_type"`
	Resource    Resource `json:"resource"`
}

ExecuteResourceOperationRequest defines model for ExecuteResourceOperationRequest.

type ExecuteResourceOperationRequestOperation

type ExecuteResourceOperationRequestOperation string

ExecuteResourceOperationRequestOperation The operation to perform on the resource.

Defines values for ExecuteResourceOperationRequestOperation.

type ExecuteResourceOperationResponse

type ExecuteResourceOperationResponse struct {
	Resource *Resource `json:"resource,omitempty"`

	// ResponseType The type of response.
	ResponseType string `json:"response_type"`
}

ExecuteResourceOperationResponse defines model for ExecuteResourceOperationResponse.

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

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 Links struct {
	Links *[]LinksItem `json:"links,omitempty"`
}

Links defines model for Links.

type LinksItem

type LinksItem struct {
	// Title The title of the link.
	Title string `json:"title"`

	// Type The type of link.
	Type LinksItemType `json:"type"`

	// Url The URL of the link
	Url string `json:"url"`
}

LinksItem defines model for LinksItem.

type LinksItemType

type LinksItemType string

LinksItemType The type of link.

const (
	Administration LinksItemType = "administration"
	Documentation  LinksItemType = "documentation"
	Endpoint       LinksItemType = "endpoint"
	External       LinksItemType = "external"
	Support        LinksItemType = "support"
)

Defines values for LinksItemType.

type ListResourcesRequest

type ListResourcesRequest struct {
	// Metadata Metadata associated with the resource operation.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`

	// Next The next page token for pagination.
	Next string `json:"next"`

	// RequestType The type of request.
	RequestType string   `json:"request_type"`
	Resource    Resource `json:"resource"`
}

ListResourcesRequest defines model for ListResourcesRequest.

type ListResourcesResponse

type ListResourcesResponse struct {
	// Next The next page token for pagination.
	Next string `json:"next"`

	// Resources The resources that were listed.
	Resources []Resource `json:"resources"`

	// ResponseType The type of response.
	ResponseType string `json:"response_type"`
}

ListResourcesResponse defines model for ListResourcesResponse.

type Metadata

type Metadata struct {
	// TempestAppUrl URL of the app in the Tempest web interface.
	TempestAppUrl *string `json:"tempest_app_url,omitempty"`
}

Metadata defines model for Metadata.

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type NextResponse

type NextResponse struct {
	Metadata TaskMetadata      `json:"metadata"`
	Task     NextResponse_Task `json:"task"`

	// TaskId The unique identifier of the task.
	TaskId string `json:"task_id"`
}

NextResponse defines model for NextResponse.

type NextResponse_Task

type NextResponse_Task struct {
	// contains filtered or unexported fields
}

NextResponse_Task defines model for NextResponse.Task.

func (NextResponse_Task) AsExecuteResourceActionRequest

func (t NextResponse_Task) AsExecuteResourceActionRequest() (ExecuteResourceActionRequest, error)

AsExecuteResourceActionRequest returns the union data inside the NextResponse_Task as a ExecuteResourceActionRequest

func (NextResponse_Task) AsExecuteResourceOperationRequest

func (t NextResponse_Task) AsExecuteResourceOperationRequest() (ExecuteResourceOperationRequest, error)

AsExecuteResourceOperationRequest returns the union data inside the NextResponse_Task as a ExecuteResourceOperationRequest

func (NextResponse_Task) AsListResourcesRequest

func (t NextResponse_Task) AsListResourcesRequest() (ListResourcesRequest, error)

AsListResourcesRequest returns the union data inside the NextResponse_Task as a ListResourcesRequest

func (NextResponse_Task) Discriminator

func (t NextResponse_Task) Discriminator() (string, error)

func (*NextResponse_Task) FromExecuteResourceActionRequest

func (t *NextResponse_Task) FromExecuteResourceActionRequest(v ExecuteResourceActionRequest) error

FromExecuteResourceActionRequest overwrites any union data inside the NextResponse_Task as the provided ExecuteResourceActionRequest

func (*NextResponse_Task) FromExecuteResourceOperationRequest

func (t *NextResponse_Task) FromExecuteResourceOperationRequest(v ExecuteResourceOperationRequest) error

FromExecuteResourceOperationRequest overwrites any union data inside the NextResponse_Task as the provided ExecuteResourceOperationRequest

func (*NextResponse_Task) FromListResourcesRequest

func (t *NextResponse_Task) FromListResourcesRequest(v ListResourcesRequest) error

FromListResourcesRequest overwrites any union data inside the NextResponse_Task as the provided ListResourcesRequest

func (NextResponse_Task) MarshalJSON

func (t NextResponse_Task) MarshalJSON() ([]byte, error)

func (*NextResponse_Task) MergeExecuteResourceActionRequest

func (t *NextResponse_Task) MergeExecuteResourceActionRequest(v ExecuteResourceActionRequest) error

MergeExecuteResourceActionRequest performs a merge with any union data inside the NextResponse_Task, using the provided ExecuteResourceActionRequest

func (*NextResponse_Task) MergeExecuteResourceOperationRequest

func (t *NextResponse_Task) MergeExecuteResourceOperationRequest(v ExecuteResourceOperationRequest) error

MergeExecuteResourceOperationRequest performs a merge with any union data inside the NextResponse_Task, using the provided ExecuteResourceOperationRequest

func (*NextResponse_Task) MergeListResourcesRequest

func (t *NextResponse_Task) MergeListResourcesRequest(v ListResourcesRequest) error

MergeListResourcesRequest performs a merge with any union data inside the NextResponse_Task, using the provided ListResourcesRequest

func (*NextResponse_Task) UnmarshalJSON

func (t *NextResponse_Task) UnmarshalJSON(b []byte) error

func (NextResponse_Task) ValueByDiscriminator

func (t NextResponse_Task) ValueByDiscriminator() (interface{}, error)

type Owner

type Owner struct {
	// Email The email address of the owner.
	Email string `json:"email"`

	// Name The name of the owner.
	Name string `json:"name"`

	// Type The type of owner.
	Type OwnerType `json:"type"`
}

Owner defines model for Owner.

type OwnerType

type OwnerType string

OwnerType The type of owner.

const (
	Team OwnerType = "team"
	User OwnerType = "user"
)

Defines values for OwnerType.

type PostAppsOperationsNext200JSONResponse

type PostAppsOperationsNext200JSONResponse NextResponse

func (PostAppsOperationsNext200JSONResponse) VisitPostAppsOperationsNextResponse

func (response PostAppsOperationsNext200JSONResponse) VisitPostAppsOperationsNextResponse(w http.ResponseWriter) error

type PostAppsOperationsNext204Response

type PostAppsOperationsNext204Response struct {
}

func (PostAppsOperationsNext204Response) VisitPostAppsOperationsNextResponse

func (response PostAppsOperationsNext204Response) VisitPostAppsOperationsNextResponse(w http.ResponseWriter) error

type PostAppsOperationsNext400JSONResponse added in v0.1.1

type PostAppsOperationsNext400JSONResponse ErrorResponse

func (PostAppsOperationsNext400JSONResponse) VisitPostAppsOperationsNextResponse added in v0.1.1

func (response PostAppsOperationsNext400JSONResponse) VisitPostAppsOperationsNextResponse(w http.ResponseWriter) error

type PostAppsOperationsNext500JSONResponse

type PostAppsOperationsNext500JSONResponse ErrorResponse

func (PostAppsOperationsNext500JSONResponse) VisitPostAppsOperationsNextResponse

func (response PostAppsOperationsNext500JSONResponse) VisitPostAppsOperationsNextResponse(w http.ResponseWriter) error

type PostAppsOperationsNextJSONRequestBody

type PostAppsOperationsNextJSONRequestBody = AppRequest

PostAppsOperationsNextJSONRequestBody defines body for PostAppsOperationsNext for application/json ContentType.

type PostAppsOperationsNextRequestObject

type PostAppsOperationsNextRequestObject struct {
	Body *PostAppsOperationsNextJSONRequestBody
}

type PostAppsOperationsNextResponse

type PostAppsOperationsNextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *NextResponse
	JSON400      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostAppsOperationsNextResponse

func ParsePostAppsOperationsNextResponse(rsp *http.Response) (*PostAppsOperationsNextResponse, error)

ParsePostAppsOperationsNextResponse parses an HTTP response from a PostAppsOperationsNextWithResponse call

func (PostAppsOperationsNextResponse) Status

Status returns HTTPResponse.Status

func (PostAppsOperationsNextResponse) StatusCode

func (r PostAppsOperationsNextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostAppsOperationsNextResponseObject

type PostAppsOperationsNextResponseObject interface {
	VisitPostAppsOperationsNextResponse(w http.ResponseWriter) error
}

type PostAppsOperationsReport200JSONResponse

type PostAppsOperationsReport200JSONResponse StandardResponse

func (PostAppsOperationsReport200JSONResponse) VisitPostAppsOperationsReportResponse

func (response PostAppsOperationsReport200JSONResponse) VisitPostAppsOperationsReportResponse(w http.ResponseWriter) error

type PostAppsOperationsReport400JSONResponse

type PostAppsOperationsReport400JSONResponse ErrorResponse

func (PostAppsOperationsReport400JSONResponse) VisitPostAppsOperationsReportResponse

func (response PostAppsOperationsReport400JSONResponse) VisitPostAppsOperationsReportResponse(w http.ResponseWriter) error

type PostAppsOperationsReport404JSONResponse

type PostAppsOperationsReport404JSONResponse ErrorResponse

func (PostAppsOperationsReport404JSONResponse) VisitPostAppsOperationsReportResponse

func (response PostAppsOperationsReport404JSONResponse) VisitPostAppsOperationsReportResponse(w http.ResponseWriter) error

type PostAppsOperationsReport500JSONResponse

type PostAppsOperationsReport500JSONResponse ErrorResponse

func (PostAppsOperationsReport500JSONResponse) VisitPostAppsOperationsReportResponse

func (response PostAppsOperationsReport500JSONResponse) VisitPostAppsOperationsReportResponse(w http.ResponseWriter) error

type PostAppsOperationsReportJSONRequestBody

type PostAppsOperationsReportJSONRequestBody = ReportResponse

PostAppsOperationsReportJSONRequestBody defines body for PostAppsOperationsReport for application/json ContentType.

type PostAppsOperationsReportRequestObject

type PostAppsOperationsReportRequestObject struct {
	Body *PostAppsOperationsReportJSONRequestBody
}

type PostAppsOperationsReportResponse

type PostAppsOperationsReportResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *StandardResponse
	JSON400      *ErrorResponse
	JSON404      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostAppsOperationsReportResponse

func ParsePostAppsOperationsReportResponse(rsp *http.Response) (*PostAppsOperationsReportResponse, error)

ParsePostAppsOperationsReportResponse parses an HTTP response from a PostAppsOperationsReportWithResponse call

func (PostAppsOperationsReportResponse) Status

Status returns HTTPResponse.Status

func (PostAppsOperationsReportResponse) StatusCode

func (r PostAppsOperationsReportResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostAppsOperationsReportResponseObject

type PostAppsOperationsReportResponseObject interface {
	VisitPostAppsOperationsReportResponse(w http.ResponseWriter) error
}

type PostAppsVersionConnect200JSONResponse

type PostAppsVersionConnect200JSONResponse StandardResponse

func (PostAppsVersionConnect200JSONResponse) VisitPostAppsVersionConnectResponse

func (response PostAppsVersionConnect200JSONResponse) VisitPostAppsVersionConnectResponse(w http.ResponseWriter) error

type PostAppsVersionConnect400JSONResponse

type PostAppsVersionConnect400JSONResponse ErrorResponse

func (PostAppsVersionConnect400JSONResponse) VisitPostAppsVersionConnectResponse

func (response PostAppsVersionConnect400JSONResponse) VisitPostAppsVersionConnectResponse(w http.ResponseWriter) error

type PostAppsVersionConnect500JSONResponse

type PostAppsVersionConnect500JSONResponse ErrorResponse

func (PostAppsVersionConnect500JSONResponse) VisitPostAppsVersionConnectResponse

func (response PostAppsVersionConnect500JSONResponse) VisitPostAppsVersionConnectResponse(w http.ResponseWriter) error

type PostAppsVersionConnectJSONBody

type PostAppsVersionConnectJSONBody struct {
	// AppId The unique identifier of the application.
	AppId     string               `json:"app_id"`
	Resources []ResourceDefinition `json:"resources"`

	// Version The version of the application.
	Version string `json:"version"`
}

PostAppsVersionConnectJSONBody defines parameters for PostAppsVersionConnect.

type PostAppsVersionConnectJSONRequestBody

type PostAppsVersionConnectJSONRequestBody PostAppsVersionConnectJSONBody

PostAppsVersionConnectJSONRequestBody defines body for PostAppsVersionConnect for application/json ContentType.

type PostAppsVersionConnectRequestObject

type PostAppsVersionConnectRequestObject struct {
	Body *PostAppsVersionConnectJSONRequestBody
}

type PostAppsVersionConnectResponse

type PostAppsVersionConnectResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *StandardResponse
	JSON400      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostAppsVersionConnectResponse

func ParsePostAppsVersionConnectResponse(rsp *http.Response) (*PostAppsVersionConnectResponse, error)

ParsePostAppsVersionConnectResponse parses an HTTP response from a PostAppsVersionConnectWithResponse call

func (PostAppsVersionConnectResponse) Status

Status returns HTTPResponse.Status

func (PostAppsVersionConnectResponse) StatusCode

func (r PostAppsVersionConnectResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostAppsVersionConnectResponseObject

type PostAppsVersionConnectResponseObject interface {
	VisitPostAppsVersionConnectResponse(w http.ResponseWriter) error
}

type PostAppsVersionsHealth200JSONResponse

type PostAppsVersionsHealth200JSONResponse StandardResponse

func (PostAppsVersionsHealth200JSONResponse) VisitPostAppsVersionsHealthResponse

func (response PostAppsVersionsHealth200JSONResponse) VisitPostAppsVersionsHealthResponse(w http.ResponseWriter) error

type PostAppsVersionsHealth400JSONResponse

type PostAppsVersionsHealth400JSONResponse ErrorResponse

func (PostAppsVersionsHealth400JSONResponse) VisitPostAppsVersionsHealthResponse

func (response PostAppsVersionsHealth400JSONResponse) VisitPostAppsVersionsHealthResponse(w http.ResponseWriter) error

type PostAppsVersionsHealth500JSONResponse

type PostAppsVersionsHealth500JSONResponse ErrorResponse

func (PostAppsVersionsHealth500JSONResponse) VisitPostAppsVersionsHealthResponse

func (response PostAppsVersionsHealth500JSONResponse) VisitPostAppsVersionsHealthResponse(w http.ResponseWriter) error

type PostAppsVersionsHealthJSONRequestBody

type PostAppsVersionsHealthJSONRequestBody = AppHealthReportRequest

PostAppsVersionsHealthJSONRequestBody defines body for PostAppsVersionsHealth for application/json ContentType.

type PostAppsVersionsHealthRequestObject

type PostAppsVersionsHealthRequestObject struct {
	Body *PostAppsVersionsHealthJSONRequestBody
}

type PostAppsVersionsHealthResponse

type PostAppsVersionsHealthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *StandardResponse
	JSON400      *ErrorResponse
	JSON500      *ErrorResponse
}

func ParsePostAppsVersionsHealthResponse

func ParsePostAppsVersionsHealthResponse(rsp *http.Response) (*PostAppsVersionsHealthResponse, error)

ParsePostAppsVersionsHealthResponse parses an HTTP response from a PostAppsVersionsHealthWithResponse call

func (PostAppsVersionsHealthResponse) Status

Status returns HTTPResponse.Status

func (PostAppsVersionsHealthResponse) StatusCode

func (r PostAppsVersionsHealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostAppsVersionsHealthResponseObject

type PostAppsVersionsHealthResponseObject interface {
	VisitPostAppsVersionsHealthResponse(w http.ResponseWriter) error
}

type ReportResponse

type ReportResponse struct {
	// Message A message providing additional information.
	Message  *string                 `json:"message,omitempty"`
	Response ReportResponse_Response `json:"response"`

	// Status Status of the report operation
	Status ReportResponseStatus `json:"status"`

	// TaskId The unique identifier of the task.
	TaskId string `json:"task_id"`
}

ReportResponse defines model for ReportResponse.

type ReportResponseStatus

type ReportResponseStatus string

ReportResponseStatus Status of the report operation

const (
	ReportResponseStatusError ReportResponseStatus = "error"
	ReportResponseStatusOk    ReportResponseStatus = "ok"
)

Defines values for ReportResponseStatus.

type ReportResponse_Response

type ReportResponse_Response struct {
	// contains filtered or unexported fields
}

ReportResponse_Response defines model for ReportResponse.Response.

func (ReportResponse_Response) AsExecuteResourceActionResponse

func (t ReportResponse_Response) AsExecuteResourceActionResponse() (ExecuteResourceActionResponse, error)

AsExecuteResourceActionResponse returns the union data inside the ReportResponse_Response as a ExecuteResourceActionResponse

func (ReportResponse_Response) AsExecuteResourceOperationResponse

func (t ReportResponse_Response) AsExecuteResourceOperationResponse() (ExecuteResourceOperationResponse, error)

AsExecuteResourceOperationResponse returns the union data inside the ReportResponse_Response as a ExecuteResourceOperationResponse

func (ReportResponse_Response) AsListResourcesResponse

func (t ReportResponse_Response) AsListResourcesResponse() (ListResourcesResponse, error)

AsListResourcesResponse returns the union data inside the ReportResponse_Response as a ListResourcesResponse

func (ReportResponse_Response) Discriminator

func (t ReportResponse_Response) Discriminator() (string, error)

func (*ReportResponse_Response) FromExecuteResourceActionResponse

func (t *ReportResponse_Response) FromExecuteResourceActionResponse(v ExecuteResourceActionResponse) error

FromExecuteResourceActionResponse overwrites any union data inside the ReportResponse_Response as the provided ExecuteResourceActionResponse

func (*ReportResponse_Response) FromExecuteResourceOperationResponse

func (t *ReportResponse_Response) FromExecuteResourceOperationResponse(v ExecuteResourceOperationResponse) error

FromExecuteResourceOperationResponse overwrites any union data inside the ReportResponse_Response as the provided ExecuteResourceOperationResponse

func (*ReportResponse_Response) FromListResourcesResponse

func (t *ReportResponse_Response) FromListResourcesResponse(v ListResourcesResponse) error

FromListResourcesResponse overwrites any union data inside the ReportResponse_Response as the provided ListResourcesResponse

func (ReportResponse_Response) MarshalJSON

func (t ReportResponse_Response) MarshalJSON() ([]byte, error)

func (*ReportResponse_Response) MergeExecuteResourceActionResponse

func (t *ReportResponse_Response) MergeExecuteResourceActionResponse(v ExecuteResourceActionResponse) error

MergeExecuteResourceActionResponse performs a merge with any union data inside the ReportResponse_Response, using the provided ExecuteResourceActionResponse

func (*ReportResponse_Response) MergeExecuteResourceOperationResponse

func (t *ReportResponse_Response) MergeExecuteResourceOperationResponse(v ExecuteResourceOperationResponse) error

MergeExecuteResourceOperationResponse performs a merge with any union data inside the ReportResponse_Response, using the provided ExecuteResourceOperationResponse

func (*ReportResponse_Response) MergeListResourcesResponse

func (t *ReportResponse_Response) MergeListResourcesResponse(v ListResourcesResponse) error

MergeListResourcesResponse performs a merge with any union data inside the ReportResponse_Response, using the provided ListResourcesResponse

func (*ReportResponse_Response) UnmarshalJSON

func (t *ReportResponse_Response) UnmarshalJSON(b []byte) error

func (ReportResponse_Response) ValueByDiscriminator

func (t ReportResponse_Response) ValueByDiscriminator() (interface{}, 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 Resource

type Resource struct {
	// DisplayName The display name of the resource.
	DisplayName string `json:"display_name"`

	// ExternalId The external identifier of the resource.
	ExternalId string `json:"external_id"`
	Links      *Links `json:"links,omitempty"`

	// Properties Properties of the resource.
	Properties *map[string]interface{} `json:"properties,omitempty"`

	// Type The unique type of the resource.
	Type string `json:"type"`
}

Resource defines model for Resource.

type ResourceDefinition

type ResourceDefinition struct {
	// Actions Actions that can be performed on this resource.
	Actions *[]ActionDefinition `json:"actions,omitempty"`

	// CreateInputSchema JSON schema that defines the input for the create operation.
	CreateInputSchema *map[string]interface{} `json:"create_input_schema,omitempty"`

	// CreateSupported Whether the resource supports the create operation.
	CreateSupported bool `json:"create_supported"`

	// DeleteSupported Whether the resource supports the delete operation.
	DeleteSupported bool `json:"delete_supported"`

	// Description A description of the resource.
	Description string `json:"description"`

	// DisplayName The display name of the resource.
	DisplayName string `json:"display_name"`

	// HealthcheckSupported Whether the resource supports health checks.
	HealthcheckSupported bool `json:"healthcheck_supported"`

	// InstructionsMarkdown Markdown instructions for the resource.
	InstructionsMarkdown *string `json:"instructions_markdown,omitempty"`

	// LifecycleStage The lifecycle stage of this resource.
	LifecycleStage string `json:"lifecycle_stage"`
	Links          *Links `json:"links,omitempty"`

	// ListSupported Whether the resource supports the list operation.
	ListSupported bool `json:"list_supported"`

	// PropertyJsonSchema JSON schema defining properties of the resource.
	PropertyJsonSchema *map[string]interface{} `json:"property_json_schema,omitempty"`

	// ReadSupported Whether the resource supports the read operation.
	ReadSupported bool `json:"read_supported"`

	// Type The type of the resource.
	Type string `json:"type"`

	// UpdateInputSchema JSON schema that defines the input for the update operation.
	UpdateInputSchema *map[string]interface{} `json:"update_input_schema,omitempty"`

	// UpdateSupported Whether the resource supports the update operation.
	UpdateSupported bool `json:"update_supported"`
}

ResourceDefinition defines model for ResourceDefinition.

type ServerInterface

type ServerInterface interface {
	// Retrieve the next task to execute
	// (POST /apps.operations.next)
	PostAppsOperationsNext(w http.ResponseWriter, r *http.Request)
	// Report the result of a task execution
	// (POST /apps.operations.report)
	PostAppsOperationsReport(w http.ResponseWriter, r *http.Request)
	// Connect to a specific app version
	// (POST /apps.version.connect)
	PostAppsVersionConnect(w http.ResponseWriter, r *http.Request)
	// Handles health check reports for apps
	// (POST /apps.versions.health)
	PostAppsVersionsHealth(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) PostAppsOperationsNext

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

PostAppsOperationsNext operation middleware

func (*ServerInterfaceWrapper) PostAppsOperationsReport

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

PostAppsOperationsReport operation middleware

func (*ServerInterfaceWrapper) PostAppsVersionConnect

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

PostAppsVersionConnect operation middleware

func (*ServerInterfaceWrapper) PostAppsVersionsHealth

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

PostAppsVersionsHealth operation middleware

type StandardResponse

type StandardResponse struct {
	// Error Error message if the operation fails.
	Error *string `json:"error"`

	// Message A message providing additional information.
	Message  *string   `json:"message,omitempty"`
	Metadata *Metadata `json:"metadata,omitempty"`

	// Status Status of the report operation
	Status StandardResponseStatus `json:"status"`
}

StandardResponse defines model for StandardResponse.

type StandardResponseStatus

type StandardResponseStatus string

StandardResponseStatus Status of the report operation

const (
	Error StandardResponseStatus = "error"
	Ok    StandardResponseStatus = "ok"
)

Defines values for StandardResponseStatus.

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 {
	// Retrieve the next task to execute
	// (POST /apps.operations.next)
	PostAppsOperationsNext(ctx context.Context, request PostAppsOperationsNextRequestObject) (PostAppsOperationsNextResponseObject, error)
	// Report the result of a task execution
	// (POST /apps.operations.report)
	PostAppsOperationsReport(ctx context.Context, request PostAppsOperationsReportRequestObject) (PostAppsOperationsReportResponseObject, error)
	// Connect to a specific app version
	// (POST /apps.version.connect)
	PostAppsVersionConnect(ctx context.Context, request PostAppsVersionConnectRequestObject) (PostAppsVersionConnectResponseObject, error)
	// Handles health check reports for apps
	// (POST /apps.versions.health)
	PostAppsVersionsHealth(ctx context.Context, request PostAppsVersionsHealthRequestObject) (PostAppsVersionsHealthResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TaskMetadata

type TaskMetadata struct {
	Author Owner `json:"author"`

	// Owners The owners of the task.
	Owners []Owner `json:"owners"`

	// ProjectId The unique identifier of the project.
	ProjectId string `json:"project_id"`

	// ProjectName The name of the project.
	ProjectName string `json:"project_name"`
}

TaskMetadata defines model for TaskMetadata.

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

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

Retrieve the next task to execute (POST /apps.operations.next)

func (Unimplemented) PostAppsOperationsReport

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

Report the result of a task execution (POST /apps.operations.report)

func (Unimplemented) PostAppsVersionConnect

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

Connect to a specific app version (POST /apps.version.connect)

func (Unimplemented) PostAppsVersionsHealth

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

Handles health check reports for apps (POST /apps.versions.health)

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

Jump to

Keyboard shortcuts

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