v20250407

package
v1.26.1 Latest Latest
Warning

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

Go to latest
Published: Feb 12, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package v20250407 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 ApiVersion = "2025-04-07"
View Source
const DocumentApiVersion = "2025-04-07"

Variables

This section is empty.

Functions

func NewCreateTestRequestWithApplicationVndAPIPlusJSONBody

func NewCreateTestRequestWithApplicationVndAPIPlusJSONBody(server string, orgId externalRef2.OrgId, params *CreateTestParams, body CreateTestApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewCreateTestRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateTest builder with application/vnd.api+json body

func NewCreateTestRequestWithBody

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

NewCreateTestRequestWithBody generates requests for CreateTest with any type of body

func NewGetComponentsRequest

func NewGetComponentsRequest(server string, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetComponentsParams) (*http.Request, error)

NewGetComponentsRequest generates requests for GetComponents

func NewGetComponentsState

func NewGetComponentsState() *v20250407.GetComponentsResponse

func NewGetTestInitialConfigurationRequest

func NewGetTestInitialConfigurationRequest(server string, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestInitialConfigurationParams) (*http.Request, error)

NewGetTestInitialConfigurationRequest generates requests for GetTestInitialConfiguration

func NewGetTestResultRequest

func NewGetTestResultRequest(server string, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestResultParams) (*http.Request, error)

NewGetTestResultRequest generates requests for GetTestResult

func NewTestInputLegacyScmProject

func NewTestInputLegacyScmProject(projectId openapi_types.UUID, commitId string) v20250407.TestInputLegacyScmProject

func NewTestResponse

func NewTestResponse() *v20250407.TestResult

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

func (c *Client) CreateTestWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateTestParams, body CreateTestApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTestWithBody

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

func (*Client) GetComponents

func (c *Client) GetComponents(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetComponentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTestInitialConfiguration

func (c *Client) GetTestInitialConfiguration(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestInitialConfigurationParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTestResult

func (c *Client) GetTestResult(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestResultParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

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

	CreateTestWithApplicationVndAPIPlusJSONBody(ctx context.Context, orgId externalRef2.OrgId, params *CreateTestParams, body CreateTestApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTestResult request
	GetTestResult(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestResultParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetComponents request
	GetComponents(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetComponentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTestInitialConfiguration request
	GetTestInitialConfiguration(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestInitialConfigurationParams, 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) CreateTestWithApplicationVndAPIPlusJSONBodyWithResponse

func (c *ClientWithResponses) CreateTestWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateTestParams, body CreateTestApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTestResponse, error)

func (*ClientWithResponses) CreateTestWithBodyWithResponse

func (c *ClientWithResponses) CreateTestWithBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateTestParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTestResponse, error)

CreateTestWithBodyWithResponse request with arbitrary body returning *CreateTestResponse

func (*ClientWithResponses) GetComponentsWithResponse

func (c *ClientWithResponses) GetComponentsWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetComponentsParams, reqEditors ...RequestEditorFn) (*GetComponentsResponse, error)

GetComponentsWithResponse request returning *GetComponentsResponse

func (*ClientWithResponses) GetTestInitialConfigurationWithResponse

func (c *ClientWithResponses) GetTestInitialConfigurationWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestInitialConfigurationParams, reqEditors ...RequestEditorFn) (*GetTestInitialConfigurationResponse, error)

GetTestInitialConfigurationWithResponse request returning *GetTestInitialConfigurationResponse

func (*ClientWithResponses) GetTestResultWithResponse

func (c *ClientWithResponses) GetTestResultWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestResultParams, reqEditors ...RequestEditorFn) (*GetTestResultResponse, error)

GetTestResultWithResponse request returning *GetTestResultResponse

type ClientWithResponsesInterface

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

	CreateTestWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, orgId externalRef2.OrgId, params *CreateTestParams, body CreateTestApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTestResponse, error)

	// GetTestResultWithResponse request
	GetTestResultWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestResultParams, reqEditors ...RequestEditorFn) (*GetTestResultResponse, error)

	// GetComponentsWithResponse request
	GetComponentsWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetComponentsParams, reqEditors ...RequestEditorFn) (*GetComponentsResponse, error)

	// GetTestInitialConfigurationWithResponse request
	GetTestInitialConfigurationWithResponse(ctx context.Context, orgId externalRef2.OrgId, testId externalRef2.TestId, params *GetTestInitialConfigurationParams, reqEditors ...RequestEditorFn) (*GetTestInitialConfigurationResponse, error)
}

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

type CreateTestApplicationVndAPIPlusJSONRequestBody

type CreateTestApplicationVndAPIPlusJSONRequestBody = externalRef1.CreateTestRequestBody

CreateTestApplicationVndAPIPlusJSONRequestBody defines body for CreateTest for application/vnd.api+json ContentType.

type CreateTestOption

type CreateTestOption func(*CreateTestApplicationVndAPIPlusJSONRequestBody)

func WithInputBundle

func WithInputBundle(id string, localFilePath string, repoUrl *string, limitTestToFiles []string, commitId *string, branch *string) CreateTestOption

func WithProjectId

func WithProjectId(id openapi_types.UUID) CreateTestOption

func WithProjectName

func WithProjectName(name *string) CreateTestOption

func WithReporting

func WithReporting(report *bool) CreateTestOption

func WithTargetName

func WithTargetName(name *string) CreateTestOption

func WithTargetReference

func WithTargetReference(targetRef *string) CreateTestOption

type CreateTestParams

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

CreateTestParams defines parameters for CreateTest.

type CreateTestResponse

type CreateTestResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *externalRef1.TestResponse
	ApplicationvndApiJSON400 *externalRef0.N400
	ApplicationvndApiJSON401 *externalRef0.N401
	ApplicationvndApiJSON403 *externalRef0.N403
	ApplicationvndApiJSON404 *externalRef0.N404
	ApplicationvndApiJSON429 *externalRef0.ErrorDocument
	ApplicationvndApiJSON500 *externalRef0.N500
}

func ParseCreateTestResponse

func ParseCreateTestResponse(rsp *http.Response) (*CreateTestResponse, error)

ParseCreateTestResponse parses an HTTP response from a CreateTestWithResponse call

func (CreateTestResponse) Status

func (r CreateTestResponse) Status() string

Status returns HTTPResponse.Status

func (CreateTestResponse) StatusCode

func (r CreateTestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetComponentsParams

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

	// Limit Number of results to return per page
	Limit *externalRef0.Limit `form:"limit,omitempty" json:"limit,omitempty"`

	// StartingAfter Return the page of results immediately after this cursor
	StartingAfter *externalRef0.StartingAfter `form:"starting_after,omitempty" json:"starting_after,omitempty"`

	// EndingBefore Return the page of results immediately before this cursor
	EndingBefore *externalRef0.EndingBefore `form:"ending_before,omitempty" json:"ending_before,omitempty"`
}

GetComponentsParams defines parameters for GetComponents.

type GetComponentsResponse

type GetComponentsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *externalRef1.GetComponentsResponse
	ApplicationvndApiJSON400 *externalRef0.N400
	ApplicationvndApiJSON401 *externalRef0.N401
	ApplicationvndApiJSON403 *externalRef0.N403
	ApplicationvndApiJSON404 *externalRef0.N404
	ApplicationvndApiJSON500 *externalRef0.N500
}

func ParseGetComponentsResponse

func ParseGetComponentsResponse(rsp *http.Response) (*GetComponentsResponse, error)

ParseGetComponentsResponse parses an HTTP response from a GetComponentsWithResponse call

func (GetComponentsResponse) Status

func (r GetComponentsResponse) Status() string

Status returns HTTPResponse.Status

func (GetComponentsResponse) StatusCode

func (r GetComponentsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTestInitialConfigurationParams

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

GetTestInitialConfigurationParams defines parameters for GetTestInitialConfiguration.

type GetTestInitialConfigurationResponse

type GetTestInitialConfigurationResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *externalRef1.TestInitialConfigurationResponse
	ApplicationvndApiJSON400 *externalRef0.N400
	ApplicationvndApiJSON401 *externalRef0.N401
	ApplicationvndApiJSON403 *externalRef0.N403
	ApplicationvndApiJSON404 *externalRef0.N404
	ApplicationvndApiJSON429 *externalRef0.ErrorDocument
	ApplicationvndApiJSON500 *externalRef0.N500
}

func ParseGetTestInitialConfigurationResponse

func ParseGetTestInitialConfigurationResponse(rsp *http.Response) (*GetTestInitialConfigurationResponse, error)

ParseGetTestInitialConfigurationResponse parses an HTTP response from a GetTestInitialConfigurationWithResponse call

func (GetTestInitialConfigurationResponse) Status

Status returns HTTPResponse.Status

func (GetTestInitialConfigurationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetTestResultParams

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

GetTestResultParams defines parameters for GetTestResult.

type GetTestResultResponse

type GetTestResultResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *externalRef1.TestResult
	ApplicationvndApiJSON400 *externalRef0.N400
	ApplicationvndApiJSON401 *externalRef0.N401
	ApplicationvndApiJSON403 *externalRef0.N403
	ApplicationvndApiJSON404 *externalRef0.N404
	ApplicationvndApiJSON429 *externalRef0.ErrorDocument
	ApplicationvndApiJSON500 *externalRef0.N500
}

func ParseGetTestResultResponse

func ParseGetTestResultResponse(rsp *http.Response) (*GetTestResultResponse, error)

ParseGetTestResultResponse parses an HTTP response from a GetTestResultWithResponse call

func (GetTestResultResponse) Status

func (r GetTestResultResponse) Status() string

Status returns HTTPResponse.Status

func (GetTestResultResponse) StatusCode

func (r GetTestResultResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

Directories

Path Synopsis
Package v20250407 provides primitives to interact with the openapi HTTP API.
Package v20250407 provides primitives to interact with the openapi HTTP API.
Package v20250407 provides primitives to interact with the openapi HTTP API.
Package v20250407 provides primitives to interact with the openapi HTTP API.
Package v20250407 provides primitives to interact with the openapi HTTP API.
Package v20250407 provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

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