schema

Documentation

Index

• type Bucket
• type BucketCreateResponse
• type BucketGetResponse
• type BucketListResponse
• type BucketTeam
• type CreatedBy
• type Emails
• type Environment
• type EnvironmentBase
• type EnvironmentCreateRequest
• type EnvironmentCreateResponse
• type EnvironmentGetResponse
• type EnvironmentIntegration
• type EnvironmentRemoteAgent
• type EnvironmentUpdateRequest
• type EnvironmentUpdateResponse
• type Integration
• type IntegrationListResponse
• type Recipient
• type RemoteAgent
• type RemoteAgentListResponse
• type Schedule
• type ScheduleBase
• type ScheduleCreateRequest
• type ScheduleCreateResponse
• type ScheduleGetResponse
• type ScheduleUpdateRequest
• type ScheduleUpdateResponse
• type Step
• type StepAssertion
• type StepAuth
• type StepBase
• type StepCreateRequest
• type StepCreateResponse
• type StepGetResponse
• type StepUpdateRequest
• type StepUpdateResponse
• type StepVariable
• type Test
• type TestBase
• type TestCreateRequest
• type TestCreateResponse
• type TestGetResponse
• type TestMinimal
• type TestStep
• type TestUpdateRequest
• type TestUpdateResponse

Types

type Bucket

type Bucket struct {
	Key        string     `json:"key"`
	Name       string     `json:"name"`
	Team       BucketTeam `json:"team"`
	AuthToken  string     `json:"auth_token"`
	Default    bool       `json:"default"`
	VerifySSL  bool       `json:"verify_ssl"`
	TriggerURL string     `json:"trigger_url"`
}

type BucketCreateResponse

type BucketCreateResponse struct {
	Bucket `json:"data"`
}

type BucketGetResponse

type BucketGetResponse struct {
	Bucket `json:"data"`
}

type BucketListResponse

type BucketListResponse struct {
	Buckets []Bucket `json:"data"`
}

type BucketTeam

type BucketTeam struct {
	Name string `json:"name"`
	Id   string `json:"id"`
}

type CreatedBy

type CreatedBy struct {
	Id    string `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`
}

type Emails

type Emails struct {
	NotifyAll       bool        `json:"notify_all"`
	NotifyOn        string      `json:"notify_on"`
	NotifyThreshold int         `json:"notify_threshold"`
	Recipients      []Recipient `json:"recipients"`
}

type Environment

type Environment struct {
	EnvironmentBase
	Id string `json:"id"`
}

type EnvironmentBase

type EnvironmentBase struct {
	Name                string                   `json:"name"`
	Script              string                   `json:"script"`
	PreserveCookies     bool                     `json:"preserve_cookies"`
	InitialVariables    map[string]string        `json:"initial_variables"`
	Integrations        []EnvironmentIntegration `json:"integrations"`
	Regions             []string                 `json:"regions"`
	RemoteAgents        []EnvironmentRemoteAgent `json:"remote_agents"`
	RetryOnFailure      bool                     `json:"retry_on_failure"`
	StopOnFailure       bool                     `json:"stop_on_failure"`
	VerifySSL           bool                     `json:"verify_ssl"`
	Webhooks            []string                 `json:"webhooks"`
	Emails              Emails                   `json:"emails"`
	ParentEnvironmentId string                   `json:"parent_environment_id,omitempty"`
	ClientCertificate   string                   `json:"client_certificate"`
}

type EnvironmentCreateRequest

type EnvironmentCreateRequest struct {
	EnvironmentBase
}

type EnvironmentCreateResponse

type EnvironmentCreateResponse struct {
	Environment `json:"data"`
}

type EnvironmentGetResponse

type EnvironmentGetResponse struct {
	Environment `json:"data"`
}

type EnvironmentIntegration

type EnvironmentIntegration struct {
	Id              string `json:"id"`
	IntegrationType string `json:"integration_type"`
	Description     string `json:"description"`
}

type EnvironmentRemoteAgent

type EnvironmentRemoteAgent struct {
	Name string `json:"name"`
	UUID string `json:"uuid"`
}

type EnvironmentUpdateRequest

type EnvironmentUpdateRequest struct {
	EnvironmentBase
}

type EnvironmentUpdateResponse

type EnvironmentUpdateResponse struct {
	Environment `json:"data"`
}

type Integration

type Integration struct {
	UUID        string `json:"uuid"`
	Type        string `json:"type"`
	Description string `json:"description"`
}

type IntegrationListResponse

type IntegrationListResponse struct {
	Integrations []Integration `json:"data"`
}

type Recipient

type Recipient struct {
	Id    string `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`
}

type RemoteAgent

type RemoteAgent struct {
	Id      string `json:"agent_id"`
	Name    string `json:"name"`
	Version string `json:"version"`
}

type RemoteAgentListResponse

type RemoteAgentListResponse struct {
	RemoteAgents []RemoteAgent `json:"data"`
}

type Schedule

type Schedule struct {
	ScheduleBase
	Id         string `json:"id"`
	ExportedAt int64  `json:"exported_at"`
}

type ScheduleBase

type ScheduleBase struct {
	EnvironmentId string `json:"environment_id"`
	Interval      string `json:"interval"`
	Note          string `json:"note"`
}

type ScheduleCreateRequest

type ScheduleCreateRequest struct {
	ScheduleBase
}

type ScheduleCreateResponse

type ScheduleCreateResponse struct {
	Schedule `json:"data"`
}

type ScheduleGetResponse

type ScheduleGetResponse struct {
	Schedule `json:"data"`
}

type ScheduleUpdateRequest

type ScheduleUpdateRequest struct {
	ScheduleBase
}

type ScheduleUpdateResponse

type ScheduleUpdateResponse struct {
	Schedule `json:"data"`
}

type Step

type Step struct {
	StepBase
	Id string `json:"id"`
}

type StepAssertion

type StepAssertion struct {
	Source     string `json:"source"`
	Property   string `json:"property"`
	Comparison string `json:"comparison"`
	Value      string `json:"value"`
}

type StepAuth

type StepAuth struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	AuthType string `json:"auth_type,omitempty"`
}

type StepBase

type StepBase struct {
	StepType      string              `json:"step_type"`
	Method        string              `json:"method"`
	URL           string              `json:"url"`
	Variables     []StepVariable      `json:"variables"`
	Assertions    []StepAssertion     `json:"assertions"`
	Headers       map[string][]string `json:"headers"`
	Auth          StepAuth            `json:"auth"`
	Body          string              `json:"body"`
	Form          map[string][]string `json:"form"`
	Scripts       []string            `json:"scripts"`
	BeforeScripts []string            `json:"before_scripts"`
	Note          string              `json:"note"`
	Skipped       bool                `json:"skipped"`
}

type StepCreateRequest

type StepCreateRequest struct {
	StepBase
}

type StepCreateResponse

type StepCreateResponse struct {
	Step []Step `json:"data"`
}

type StepGetResponse

type StepGetResponse struct {
	Step `json:"data"`
}

type StepUpdateRequest

type StepUpdateRequest struct {
	Step
}

type StepUpdateResponse

type StepUpdateResponse struct {
	Step Step `json:"data"`
}

type StepVariable

type StepVariable struct {
	Name     string `json:"name"`
	Property string `json:"property"`
	Source   string `json:"source"`
}

type Test

type Test struct {
	TestBase
	Id         string     `json:"id"`
	Steps      []TestStep `json:"steps"`
	CreatedAt  int64      `json:"created_at"`
	CreatedBy  CreatedBy  `json:"created_by"`
	TriggerURL string     `json:"trigger_url"`
}

type TestBase

type TestBase struct {
	TestMinimal
	DefaultEnvironmentId string `json:"default_environment_id"`
}

type TestCreateRequest

type TestCreateRequest struct {
	TestMinimal
}

type TestCreateResponse

type TestCreateResponse struct {
	Test `json:"data"`
}

type TestGetResponse

type TestGetResponse struct {
	Test `json:"data"`
}

type TestMinimal

type TestMinimal struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

type TestStep

type TestStep struct {
	Id string `json:"id"`
}

type TestUpdateRequest

type TestUpdateRequest struct {
	TestBase
}

type TestUpdateResponse

type TestUpdateResponse struct {
	Test `json:"data"`
}