shared

package
v3.2.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2024 License: Apache-2.0 Imports: 4 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// The ID of this Api. This is a human-readable name (subject to change).
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the Api.
	Description string `json:"description"`
	// Determines if all the endpoints within the Api are found in the OpenAPI spec associated with the Api.
	Matched *bool `json:"matched,omitempty"`
	// A set of values associated with a meta_data key. This field is only set on get requests.
	MetaData map[string][]string `json:"meta_data,omitempty"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at"`
	// The version ID of this Api. This is semantic version identifier.
	VersionID string `json:"version_id"`
	// The workspace ID this Api belongs to.
	WorkspaceID string `json:"workspace_id"`
}

API - An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.

func (*API) GetAPIID 

func (o *API) GetAPIID() string

func (*API) GetCreatedAt 

func (o *API) GetCreatedAt() time.Time

func (*API) GetDescription 

func (o *API) GetDescription() string

func (*API) GetMatched 

func (o *API) GetMatched() *bool

func (*API) GetMetaData 

func (o *API) GetMetaData() map[string][]string

func (*API) GetUpdatedAt 

func (o *API) GetUpdatedAt() time.Time

func (*API) GetVersionID 

func (o *API) GetVersionID() string

func (*API) GetWorkspaceID 

func (o *API) GetWorkspaceID() string

func (API) MarshalJSON 

func (a API) MarshalJSON() ([]byte, error)

func (*API) UnmarshalJSON 

func (a *API) UnmarshalJSON(data []byte) error

type APIEndpoint 

type APIEndpoint struct {
	// The ID of this ApiEndpoint. This is a hash of the method and path.
	APIEndpointID string `json:"api_endpoint_id"`
	// The ID of the Api this ApiEndpoint belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the ApiEndpoint.
	Description string `json:"description"`
	// A human-readable name for the ApiEndpoint.
	DisplayName string `json:"display_name"`
	// Determines if the endpoint was found in the OpenAPI spec associated with the parent Api.
	Matched *bool `json:"matched,omitempty"`
	// HTTP verb.
	Method string `json:"method"`
	// Path that handles this Api.
	Path string `json:"path"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at"`
	// The version ID of the Api this ApiEndpoint belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this ApiEndpoint belongs to.
	WorkspaceID string `json:"workspace_id"`
}

APIEndpoint - An ApiEndpoint is a description of an Endpoint for an API.

func (*APIEndpoint) GetAPIEndpointID 

func (o *APIEndpoint) GetAPIEndpointID() string

func (*APIEndpoint) GetAPIID 

func (o *APIEndpoint) GetAPIID() string

func (*APIEndpoint) GetCreatedAt 

func (o *APIEndpoint) GetCreatedAt() time.Time

func (*APIEndpoint) GetDescription 

func (o *APIEndpoint) GetDescription() string

func (*APIEndpoint) GetDisplayName 

func (o *APIEndpoint) GetDisplayName() string

func (*APIEndpoint) GetMatched 

func (o *APIEndpoint) GetMatched() *bool

func (*APIEndpoint) GetMethod 

func (o *APIEndpoint) GetMethod() string

func (*APIEndpoint) GetPath 

func (o *APIEndpoint) GetPath() string

func (*APIEndpoint) GetUpdatedAt 

func (o *APIEndpoint) GetUpdatedAt() time.Time

func (*APIEndpoint) GetVersionID 

func (o *APIEndpoint) GetVersionID() string

func (*APIEndpoint) GetWorkspaceID 

func (o *APIEndpoint) GetWorkspaceID() string

func (APIEndpoint) MarshalJSON 

func (a APIEndpoint) MarshalJSON() ([]byte, error)

func (*APIEndpoint) UnmarshalJSON 

func (a *APIEndpoint) UnmarshalJSON(data []byte) error

type APIEndpointInput 

type APIEndpointInput struct {
	// The ID of this ApiEndpoint. This is a hash of the method and path.
	APIEndpointID string `json:"api_endpoint_id"`
	// A detailed description of the ApiEndpoint.
	Description string `json:"description"`
	// A human-readable name for the ApiEndpoint.
	DisplayName string `json:"display_name"`
	// HTTP verb.
	Method string `json:"method"`
	// Path that handles this Api.
	Path string `json:"path"`
	// The version ID of the Api this ApiEndpoint belongs to.
	VersionID string `json:"version_id"`
}

APIEndpointInput - An ApiEndpoint is a description of an Endpoint for an API.

func (*APIEndpointInput) GetAPIEndpointID 

func (o *APIEndpointInput) GetAPIEndpointID() string

func (*APIEndpointInput) GetDescription 

func (o *APIEndpointInput) GetDescription() string

func (*APIEndpointInput) GetDisplayName 

func (o *APIEndpointInput) GetDisplayName() string

func (*APIEndpointInput) GetMethod 

func (o *APIEndpointInput) GetMethod() string

func (*APIEndpointInput) GetPath 

func (o *APIEndpointInput) GetPath() string

func (*APIEndpointInput) GetVersionID 

func (o *APIEndpointInput) GetVersionID() string

type APIInput 

type APIInput struct {
	// The ID of this Api. This is a human-readable name (subject to change).
	APIID string `json:"api_id"`
	// A detailed description of the Api.
	Description string `json:"description"`
	// A set of values associated with a meta_data key. This field is only set on get requests.
	MetaData map[string][]string `json:"meta_data,omitempty"`
	// The version ID of this Api. This is semantic version identifier.
	VersionID string `json:"version_id"`
}

APIInput - An Api is representation of a API (a collection of API Endpoints) within the Speakeasy Platform.

func (*APIInput) GetAPIID 

func (o *APIInput) GetAPIID() string

func (*APIInput) GetDescription 

func (o *APIInput) GetDescription() string

func (*APIInput) GetMetaData 

func (o *APIInput) GetMetaData() map[string][]string

func (*APIInput) GetVersionID 

func (o *APIInput) GetVersionID() string

type APIKeyDetails added in v3.1.0 

type APIKeyDetails struct {
	WorkspaceID string `json:"workspace_id"`
}

func (*APIKeyDetails) GetWorkspaceID added in v3.1.0 

func (o *APIKeyDetails) GetWorkspaceID() string

type BoundedRequest 

type BoundedRequest struct {
	// The ID of the ApiEndpoint this request was made to.
	APIEndpointID string `json:"api_endpoint_id"`
	// The ID of the Api this request was made to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The ID of the customer that made this request.
	CustomerID string `json:"customer_id"`
	// The latency of the request.
	Latency int64 `json:"latency"`
	// Metadata associated with this request
	Metadata []RequestMetadata `json:"metadata,omitempty"`
	// HTTP verb.
	Method string `json:"method"`
	// The path of the request.
	Path string `json:"path"`
	// The time the request finished.
	RequestFinishTime time.Time `json:"request_finish_time"`
	// The ID of this request.
	RequestID string `json:"request_id"`
	// The time the request was made.
	RequestStartTime time.Time `json:"request_start_time"`
	// The status code of the request.
	Status int64 `json:"status"`
	// The version ID of the Api this request was made to.
	VersionID string `json:"version_id"`
	// The workspace ID this request was made to.
	WorkspaceID string `json:"workspace_id"`
}

A BoundedRequest is a request that has been logged by the Speakeasy without the contents of the request.

func (*BoundedRequest) GetAPIEndpointID 

func (o *BoundedRequest) GetAPIEndpointID() string

func (*BoundedRequest) GetAPIID 

func (o *BoundedRequest) GetAPIID() string

func (*BoundedRequest) GetCreatedAt 

func (o *BoundedRequest) GetCreatedAt() time.Time

func (*BoundedRequest) GetCustomerID 

func (o *BoundedRequest) GetCustomerID() string

func (*BoundedRequest) GetLatency 

func (o *BoundedRequest) GetLatency() int64

func (*BoundedRequest) GetMetadata 

func (o *BoundedRequest) GetMetadata() []RequestMetadata

func (*BoundedRequest) GetMethod 

func (o *BoundedRequest) GetMethod() string

func (*BoundedRequest) GetPath 

func (o *BoundedRequest) GetPath() string

func (*BoundedRequest) GetRequestFinishTime 

func (o *BoundedRequest) GetRequestFinishTime() time.Time

func (*BoundedRequest) GetRequestID 

func (o *BoundedRequest) GetRequestID() string

func (*BoundedRequest) GetRequestStartTime 

func (o *BoundedRequest) GetRequestStartTime() time.Time

func (*BoundedRequest) GetStatus 

func (o *BoundedRequest) GetStatus() int64

func (*BoundedRequest) GetVersionID 

func (o *BoundedRequest) GetVersionID() string

func (*BoundedRequest) GetWorkspaceID 

func (o *BoundedRequest) GetWorkspaceID() string

func (BoundedRequest) MarshalJSON 

func (b BoundedRequest) MarshalJSON() ([]byte, error)

func (*BoundedRequest) UnmarshalJSON 

func (b *BoundedRequest) UnmarshalJSON(data []byte) error

type CliEvent added in v3.1.0 

type CliEvent struct {
	// Remote commit ID.
	CommitHead *string `json:"commit_head,omitempty"`
	// Timestamp when the event was created in the database.
	CreatedAt time.Time `json:"created_at"`
	// Duration of the event in milliseconds.
	DurationMs *int64 `json:"duration_ms,omitempty"`
	// Unique identifier for each execution of the CLI.
	ExecutionID string `json:"execution_id"`
	// Bump type of the lock file (calculated semver delta, or a custom change (manual release))
	GenerateBumpType *GenerateBumpType `json:"generate_bump_type,omitempty"`
	// Checksum of the configuration file (post generation)
	GenerateConfigPostChecksum *string `json:"generate_config_post_checksum,omitempty"`
	// Rendered configuration file (post generation)
	GenerateConfigPostRaw *string `json:"generate_config_post_raw,omitempty"`
	// Version of the generated target (post generation)
	GenerateConfigPostVersion *string `json:"generate_config_post_version,omitempty"`
	// Checksum of the configuration file (prior to generation)
	GenerateConfigPreChecksum *string `json:"generate_config_pre_checksum,omitempty"`
	// Rendered configuration file (prior to generation)
	GenerateConfigPreRaw *string `json:"generate_config_pre_raw,omitempty"`
	// Version of the generated target (prior to generation)
	GenerateConfigPreVersion *string `json:"generate_config_pre_version,omitempty"`
	// gen.lock ID (expected to be a uuid).
	GenerateGenLockID *string `json:"generate_gen_lock_id,omitempty"`
	// Features post generation
	GenerateGenLockPostFeatures *string `json:"generate_gen_lock_post_features,omitempty"`
	// Checksum of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
	GenerateGenLockPreDocChecksum *string `json:"generate_gen_lock_pre_doc_checksum,omitempty"`
	// info.Version of the Previous Rendered OpenAPI document (prior to generation, via gen lock)
	GenerateGenLockPreDocVersion *string `json:"generate_gen_lock_pre_doc_version,omitempty"`
	// Features prior to generation
	GenerateGenLockPreFeatures *string `json:"generate_gen_lock_pre_features,omitempty"`
	// Artifact version for the Previous Generation
	GenerateGenLockPreVersion *string `json:"generate_gen_lock_pre_version,omitempty"`
	// Indicates whether tests were output.
	GenerateOutputTests *bool `json:"generate_output_tests,omitempty"`
	// Indicates whether the target was considered published.
	GeneratePublished *bool `json:"generate_published,omitempty"`
	// Expected Repo URL, for use in documentation generation.
	GenerateRepoURL *string `json:"generate_repo_url,omitempty"`
	// The target of the event.
	GenerateTarget *string `json:"generate_target,omitempty"`
	// The version of the target.
	GenerateTargetVersion *string `json:"generate_target_version,omitempty"`
	// Version of the generation logic used.
	GenerateVersion *string `json:"generate_version,omitempty"`
	// GitHub organization of the action.
	GhActionOrganization *string `json:"gh_action_organization,omitempty"`
	// GitHub repository of the action.
	GhActionRepository *string `json:"gh_action_repository,omitempty"`
	// Link to the GitHub action run.
	GhActionRunLink *string `json:"gh_action_run_link,omitempty"`
	// Version of the GitHub action.
	GhActionVersion *string `json:"gh_action_version,omitempty"`
	// Current working directory relative to the git root.
	GitRelativeCwd *string `json:"git_relative_cwd,omitempty"`
	// Default owner for git remote.
	GitRemoteDefaultOwner *string `json:"git_remote_default_owner,omitempty"`
	// Default repository name for git remote.
	GitRemoteDefaultRepo *string `json:"git_remote_default_repo,omitempty"`
	// User email from git configuration.
	GitUserEmail *string `json:"git_user_email,omitempty"`
	// User name from git configuration.
	GitUserName *string `json:"git_user_name,omitempty"`
	// Remote hostname.
	Hostname *string `json:"hostname,omitempty"`
	// Unique identifier for each event.
	ID string `json:"id"`
	// Type of interaction.
	InteractionType InteractionType `json:"interaction_type"`
	// Timestamp when the event completed, in local time.
	LocalCompletedAt *time.Time `json:"local_completed_at,omitempty"`
	// Timestamp when the event started, in local time.
	LocalStartedAt time.Time `json:"local_started_at"`
	// Checksum of the currently Rendered OpenAPI document.
	ManagementDocChecksum *string `json:"management_doc_checksum,omitempty"`
	// Version taken from info.version field of the Rendered OpenAPI document.
	ManagementDocVersion *string `json:"management_doc_version,omitempty"`
	// Full CLI command.
	RawCommand *string `json:"raw_command,omitempty"`
	// Label of the git repository.
	RepoLabel *string `json:"repo_label,omitempty"`
	// Identifier of the Speakeasy API key.
	SpeakeasyAPIKeyName string `json:"speakeasy_api_key_name"`
	// Version of the Speakeasy CLI.
	SpeakeasyVersion string `json:"speakeasy_version"`
	// Indicates whether the event was successful.
	Success bool `json:"success"`
	// Identifier of the workspace.
	WorkspaceID string `json:"workspace_id"`
}

func (*CliEvent) GetCommitHead added in v3.1.0 

func (o *CliEvent) GetCommitHead() *string

func (*CliEvent) GetCreatedAt added in v3.1.0 

func (o *CliEvent) GetCreatedAt() time.Time

func (*CliEvent) GetDurationMs added in v3.1.0 

func (o *CliEvent) GetDurationMs() *int64

func (*CliEvent) GetExecutionID added in v3.1.0 

func (o *CliEvent) GetExecutionID() string

func (*CliEvent) GetGenerateBumpType added in v3.1.0 

func (o *CliEvent) GetGenerateBumpType() *GenerateBumpType

func (*CliEvent) GetGenerateConfigPostChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostChecksum() *string

func (*CliEvent) GetGenerateConfigPostRaw added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostRaw() *string

func (*CliEvent) GetGenerateConfigPostVersion added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPostVersion() *string

func (*CliEvent) GetGenerateConfigPreChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreChecksum() *string

func (*CliEvent) GetGenerateConfigPreRaw added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreRaw() *string

func (*CliEvent) GetGenerateConfigPreVersion added in v3.1.0 

func (o *CliEvent) GetGenerateConfigPreVersion() *string

func (*CliEvent) GetGenerateGenLockID added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockID() *string

func (*CliEvent) GetGenerateGenLockPostFeatures added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPostFeatures() *string

func (*CliEvent) GetGenerateGenLockPreDocChecksum added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreDocChecksum() *string

func (*CliEvent) GetGenerateGenLockPreDocVersion added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreDocVersion() *string

func (*CliEvent) GetGenerateGenLockPreFeatures added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreFeatures() *string

func (*CliEvent) GetGenerateGenLockPreVersion added in v3.1.0 

func (o *CliEvent) GetGenerateGenLockPreVersion() *string

func (*CliEvent) GetGenerateOutputTests added in v3.1.0 

func (o *CliEvent) GetGenerateOutputTests() *bool

func (*CliEvent) GetGeneratePublished added in v3.1.0 

func (o *CliEvent) GetGeneratePublished() *bool

func (*CliEvent) GetGenerateRepoURL added in v3.1.0 

func (o *CliEvent) GetGenerateRepoURL() *string

func (*CliEvent) GetGenerateTarget added in v3.1.0 

func (o *CliEvent) GetGenerateTarget() *string

func (*CliEvent) GetGenerateTargetVersion added in v3.1.0 

func (o *CliEvent) GetGenerateTargetVersion() *string

func (*CliEvent) GetGenerateVersion added in v3.1.0 

func (o *CliEvent) GetGenerateVersion() *string

func (*CliEvent) GetGhActionOrganization added in v3.1.0 

func (o *CliEvent) GetGhActionOrganization() *string

func (*CliEvent) GetGhActionRepository added in v3.1.0 

func (o *CliEvent) GetGhActionRepository() *string
func (o *CliEvent) GetGhActionRunLink() *string

func (*CliEvent) GetGhActionVersion added in v3.1.0 

func (o *CliEvent) GetGhActionVersion() *string

func (*CliEvent) GetGitRelativeCwd added in v3.1.0 

func (o *CliEvent) GetGitRelativeCwd() *string

func (*CliEvent) GetGitRemoteDefaultOwner added in v3.1.0 

func (o *CliEvent) GetGitRemoteDefaultOwner() *string

func (*CliEvent) GetGitRemoteDefaultRepo added in v3.1.0 

func (o *CliEvent) GetGitRemoteDefaultRepo() *string

func (*CliEvent) GetGitUserEmail added in v3.1.0 

func (o *CliEvent) GetGitUserEmail() *string

func (*CliEvent) GetGitUserName added in v3.1.0 

func (o *CliEvent) GetGitUserName() *string

func (*CliEvent) GetHostname added in v3.1.0 

func (o *CliEvent) GetHostname() *string

func (*CliEvent) GetID added in v3.1.0 

func (o *CliEvent) GetID() string

func (*CliEvent) GetInteractionType added in v3.1.0 

func (o *CliEvent) GetInteractionType() InteractionType

func (*CliEvent) GetLocalCompletedAt added in v3.1.0 

func (o *CliEvent) GetLocalCompletedAt() *time.Time

func (*CliEvent) GetLocalStartedAt added in v3.1.0 

func (o *CliEvent) GetLocalStartedAt() time.Time

func (*CliEvent) GetManagementDocChecksum added in v3.1.0 

func (o *CliEvent) GetManagementDocChecksum() *string

func (*CliEvent) GetManagementDocVersion added in v3.1.0 

func (o *CliEvent) GetManagementDocVersion() *string

func (*CliEvent) GetRawCommand added in v3.1.0 

func (o *CliEvent) GetRawCommand() *string

func (*CliEvent) GetRepoLabel added in v3.1.0 

func (o *CliEvent) GetRepoLabel() *string

func (*CliEvent) GetSpeakeasyAPIKeyName added in v3.1.0 

func (o *CliEvent) GetSpeakeasyAPIKeyName() string

func (*CliEvent) GetSpeakeasyVersion added in v3.1.0 

func (o *CliEvent) GetSpeakeasyVersion() string

func (*CliEvent) GetSuccess added in v3.1.0 

func (o *CliEvent) GetSuccess() bool

func (*CliEvent) GetWorkspaceID added in v3.1.0 

func (o *CliEvent) GetWorkspaceID() string

func (CliEvent) MarshalJSON added in v3.1.0 

func (c CliEvent) MarshalJSON() ([]byte, error)

func (*CliEvent) UnmarshalJSON added in v3.1.0 

func (c *CliEvent) UnmarshalJSON(data []byte) error

type EmbedAccessTokenResponse 

type EmbedAccessTokenResponse struct {
	AccessToken string `json:"access_token"`
}

An EmbedAccessTokenResponse contains a token that can be used to embed a Speakeasy dashboard.

func (*EmbedAccessTokenResponse) GetAccessToken 

func (o *EmbedAccessTokenResponse) GetAccessToken() string

type EmbedToken 

type EmbedToken struct {
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The ID of the user that created this token.
	CreatedBy string `json:"created_by"`
	// A detailed description of the EmbedToken.
	Description string `json:"description"`
	// The time this token expires.
	ExpiresAt time.Time `json:"expires_at"`
	// The filters applied to this token.
	Filters string `json:"filters"`
	// The ID of this EmbedToken.
	ID string `json:"id"`
	// The last time this token was used.
	LastUsed *time.Time `json:"last_used,omitempty"`
	// The time this token was revoked.
	RevokedAt *time.Time `json:"revoked_at,omitempty"`
	// The ID of the user that revoked this token.
	RevokedBy *string `json:"revoked_by,omitempty"`
	// The workspace ID this token belongs to.
	WorkspaceID string `json:"workspace_id"`
}

EmbedToken - A representation of an embed token granted for working with Speakeasy components.

func (*EmbedToken) GetCreatedAt 

func (o *EmbedToken) GetCreatedAt() time.Time

func (*EmbedToken) GetCreatedBy 

func (o *EmbedToken) GetCreatedBy() string

func (*EmbedToken) GetDescription 

func (o *EmbedToken) GetDescription() string

func (*EmbedToken) GetExpiresAt 

func (o *EmbedToken) GetExpiresAt() time.Time

func (*EmbedToken) GetFilters 

func (o *EmbedToken) GetFilters() string

func (*EmbedToken) GetID 

func (o *EmbedToken) GetID() string

func (*EmbedToken) GetLastUsed 

func (o *EmbedToken) GetLastUsed() *time.Time

func (*EmbedToken) GetRevokedAt 

func (o *EmbedToken) GetRevokedAt() *time.Time

func (*EmbedToken) GetRevokedBy 

func (o *EmbedToken) GetRevokedBy() *string

func (*EmbedToken) GetWorkspaceID 

func (o *EmbedToken) GetWorkspaceID() string

func (EmbedToken) MarshalJSON 

func (e EmbedToken) MarshalJSON() ([]byte, error)

func (*EmbedToken) UnmarshalJSON 

func (e *EmbedToken) UnmarshalJSON(data []byte) error

type Filter 

type Filter struct {
	// The key of the filter.
	Key string `json:"key"`
	// The operator of the filter.
	Operator string `json:"operator"`
	// The value of the filter.
	Value string `json:"value"`
}

Filter - A filter is a key-value pair that can be used to filter a list of requests.

func (*Filter) GetKey 

func (o *Filter) GetKey() string

func (*Filter) GetOperator 

func (o *Filter) GetOperator() string

func (*Filter) GetValue 

func (o *Filter) GetValue() string

type Filters 

type Filters struct {
	// A list of filters to apply to the query.
	Filters []Filter `json:"filters"`
	// The maximum number of results to return.
	Limit int64 `json:"limit"`
	// The offset to start the query from.
	Offset int64 `json:"offset"`
	// The operator to use when combining filters.
	Operator string `json:"operator"`
}

Filters are used to query requests.

func (*Filters) GetFilters 

func (o *Filters) GetFilters() []Filter

func (*Filters) GetLimit 

func (o *Filters) GetLimit() int64

func (*Filters) GetOffset 

func (o *Filters) GetOffset() int64

func (*Filters) GetOperator 

func (o *Filters) GetOperator() string

type GenerateBumpType added in v3.1.0 

type GenerateBumpType string

GenerateBumpType - Bump type of the lock file (calculated semver delta, or a custom change (manual release)) 

const (
	GenerateBumpTypeMajor  GenerateBumpType = "major"
	GenerateBumpTypeMinor  GenerateBumpType = "minor"
	GenerateBumpTypePatch  GenerateBumpType = "patch"
	GenerateBumpTypeCustom GenerateBumpType = "custom"
	GenerateBumpTypeNone   GenerateBumpType = "none"
)

func (GenerateBumpType) ToPointer added in v3.1.0 

func (e GenerateBumpType) ToPointer() *GenerateBumpType

func (*GenerateBumpType) UnmarshalJSON added in v3.1.0 

func (e *GenerateBumpType) UnmarshalJSON(data []byte) error

type GenerateOpenAPISpecDiff 

type GenerateOpenAPISpecDiff struct {
	CurrentSchema string `json:"current_schema"`
	NewSchema     string `json:"new_schema"`
}

func (*GenerateOpenAPISpecDiff) GetCurrentSchema 

func (o *GenerateOpenAPISpecDiff) GetCurrentSchema() string

func (*GenerateOpenAPISpecDiff) GetNewSchema 

func (o *GenerateOpenAPISpecDiff) GetNewSchema() string

type InteractionType added in v3.1.0 

type InteractionType string

InteractionType - Type of interaction. 

const (
	InteractionTypeCliExec        InteractionType = "CLI_EXEC"
	InteractionTypeTargetGenerate InteractionType = "TARGET_GENERATE"
)

func (InteractionType) ToPointer added in v3.1.0 

func (e InteractionType) ToPointer() *InteractionType

func (*InteractionType) UnmarshalJSON added in v3.1.0 

func (e *InteractionType) UnmarshalJSON(data []byte) error

type RequestMetadata 

type RequestMetadata struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

RequestMetadata - Key-Value pairs associated with a request

func (*RequestMetadata) GetKey 

func (o *RequestMetadata) GetKey() *string

func (*RequestMetadata) GetValue 

func (o *RequestMetadata) GetValue() *string

type Schema 

type Schema struct {
	// The ID of the Api this Schema belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// A detailed description of the Schema.
	Description string `json:"description"`
	// An ID referencing this particular revision of the Schema.
	RevisionID string `json:"revision_id"`
	// The version ID of the Api this Schema belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this Schema belongs to.
	WorkspaceID string `json:"workspace_id"`
}

A Schema represents an API schema for a particular Api and Version.

func (*Schema) GetAPIID 

func (o *Schema) GetAPIID() string

func (*Schema) GetCreatedAt 

func (o *Schema) GetCreatedAt() time.Time

func (*Schema) GetDescription 

func (o *Schema) GetDescription() string

func (*Schema) GetRevisionID 

func (o *Schema) GetRevisionID() string

func (*Schema) GetVersionID 

func (o *Schema) GetVersionID() string

func (*Schema) GetWorkspaceID 

func (o *Schema) GetWorkspaceID() string

func (Schema) MarshalJSON 

func (s Schema) MarshalJSON() ([]byte, error)

func (*Schema) UnmarshalJSON 

func (s *Schema) UnmarshalJSON(data []byte) error

type SchemaDiff 

type SchemaDiff struct {
	// Holds every addition change in the diff.
	Additions []string `json:"additions"`
	// Holds every deletion change in the diff.
	Deletions []string `json:"deletions"`
	// Holds every modification change in the diff.
	Modifications map[string]ValueChange `json:"modifications"`
}

A SchemaDiff represents a diff of two Schemas.

func (*SchemaDiff) GetAdditions 

func (o *SchemaDiff) GetAdditions() []string

func (*SchemaDiff) GetDeletions 

func (o *SchemaDiff) GetDeletions() []string

func (*SchemaDiff) GetModifications 

func (o *SchemaDiff) GetModifications() map[string]ValueChange

type Security 

type Security struct {
	APIKey string `security:"scheme,type=apiKey,subtype=header,name=x-api-key"`
}

func (*Security) GetAPIKey 

func (o *Security) GetAPIKey() string

type UnboundedRequest 

type UnboundedRequest struct {
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The HAR content of the request.
	Har string `json:"har"`
	// The size of the HAR content in bytes.
	HarSizeBytes int64 `json:"har_size_bytes"`
	// The ID of this request.
	RequestID string `json:"request_id"`
	// The workspace ID this request was made to.
	WorkspaceID string `json:"workspace_id"`
}

An UnboundedRequest represents the HAR content capture by Speakeasy when logging a request.

func (*UnboundedRequest) GetCreatedAt 

func (o *UnboundedRequest) GetCreatedAt() time.Time

func (*UnboundedRequest) GetHar 

func (o *UnboundedRequest) GetHar() string

func (*UnboundedRequest) GetHarSizeBytes 

func (o *UnboundedRequest) GetHarSizeBytes() int64

func (*UnboundedRequest) GetRequestID 

func (o *UnboundedRequest) GetRequestID() string

func (*UnboundedRequest) GetWorkspaceID 

func (o *UnboundedRequest) GetWorkspaceID() string

func (UnboundedRequest) MarshalJSON 

func (u UnboundedRequest) MarshalJSON() ([]byte, error)

func (*UnboundedRequest) UnmarshalJSON 

func (u *UnboundedRequest) UnmarshalJSON(data []byte) error

type ValueChange 

type ValueChange struct {
	// Represents the previous value of the element.
	From string `json:"From"`
	// Represents the current value of the element.
	To string `json:"To"`
}

func (*ValueChange) GetFrom 

func (o *ValueChange) GetFrom() string

func (*ValueChange) GetTo 

func (o *ValueChange) GetTo() string

type VersionMetadata 

type VersionMetadata struct {
	// The ID of the Api this Metadata belongs to.
	APIID string `json:"api_id"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at"`
	// The key for this metadata.
	MetaKey string `json:"meta_key"`
	// One of the values for this metadata.
	MetaValue string `json:"meta_value"`
	// The version ID of the Api this Metadata belongs to.
	VersionID string `json:"version_id"`
	// The workspace ID this Metadata belongs to.
	WorkspaceID string `json:"workspace_id"`
}

VersionMetadata - A set of keys and associated values, attached to a particular version of an Api.

func (*VersionMetadata) GetAPIID 

func (o *VersionMetadata) GetAPIID() string

func (*VersionMetadata) GetCreatedAt 

func (o *VersionMetadata) GetCreatedAt() time.Time

func (*VersionMetadata) GetMetaKey 

func (o *VersionMetadata) GetMetaKey() string

func (*VersionMetadata) GetMetaValue 

func (o *VersionMetadata) GetMetaValue() string

func (*VersionMetadata) GetVersionID 

func (o *VersionMetadata) GetVersionID() string

func (*VersionMetadata) GetWorkspaceID 

func (o *VersionMetadata) GetWorkspaceID() string

func (VersionMetadata) MarshalJSON 

func (v VersionMetadata) MarshalJSON() ([]byte, error)

func (*VersionMetadata) UnmarshalJSON 

func (v *VersionMetadata) UnmarshalJSON(data []byte) error

type VersionMetadataInput 

type VersionMetadataInput struct {
	// The key for this metadata.
	MetaKey string `json:"meta_key"`
	// One of the values for this metadata.
	MetaValue string `json:"meta_value"`
}

VersionMetadataInput - A set of keys and associated values, attached to a particular version of an Api.

func (*VersionMetadataInput) GetMetaKey 

func (o *VersionMetadataInput) GetMetaKey() string

func (*VersionMetadataInput) GetMetaValue 

func (o *VersionMetadataInput) GetMetaValue() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

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