dtos

package
v1.205.0 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

README

DTOs

This folder contains the Data Transfer Objects (DTOs) for the Atmos CLI to communicate with the Atmos Pro API.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AtmosApiResponse

type AtmosApiResponse struct {
	Request      string                 `json:"request"`
	Status       int                    `json:"status"`
	Success      bool                   `json:"success"`
	ErrorMessage string                 `json:"errorMessage,omitempty"`
	Context      map[string]interface{} `json:"context,omitempty"`
	TraceID      string                 `json:"traceId,omitempty"`
}

type ExchangeGitHubOIDCTokenRequest

type ExchangeGitHubOIDCTokenRequest struct {
	Token       string `json:"token"`
	WorkspaceID string `json:"workspaceId"`
}

ExchangeGitHubOIDCTokenRequest represents the request to exchange OIDC token for Atmos token.

type ExchangeGitHubOIDCTokenResponse

type ExchangeGitHubOIDCTokenResponse struct {
	AtmosApiResponse
	Data struct {
		Token string `json:"token"`
	} `json:"data"`
}

ExchangeGitHubOIDCTokenResponse represents the response from Atmos Pro's OIDC auth endpoint.

type GetGitHubOIDCResponse

type GetGitHubOIDCResponse struct {
	Value string `json:"value"`
}

GetGitHubOIDCResponse represents the response from GitHub's OIDC token endpoint when requesting an OIDC token.

type InstanceStatusUploadRequest added in v1.192.0

type InstanceStatusUploadRequest struct {
	AtmosProRunID string `json:"atmos_pro_run_id"`
	GitSHA        string `json:"git_sha"`
	RepoURL       string `json:"repo_url"`
	RepoName      string `json:"repo_name"`
	RepoOwner     string `json:"repo_owner"`
	RepoHost      string `json:"repo_host"`
	Component     string `json:"component"`
	Stack         string `json:"stack"`
	HasDrift      bool   `json:"has_drift"`
}

InstanceStatusUploadRequest represents the data structure for uploading a single instance's status.

type InstancesUploadRequest added in v1.192.0

type InstancesUploadRequest struct {
	RepoURL   string            `json:"repo_url"`
	RepoName  string            `json:"repo_name"`
	RepoOwner string            `json:"repo_owner"`
	RepoHost  string            `json:"repo_host"`
	Instances []schema.Instance `json:"instances"`
}

InstancesUploadRequest represents the data structure for uploading components for drift detection. We call this from "atmos list instances".

type LockStackRequest

type LockStackRequest struct {
	Key         string                 `json:"key"`
	TTL         int32                  `json:"ttl"`
	LockMessage string                 `json:"lockMessage,omitempty"`
	Properties  map[string]interface{} `json:"properties,omitempty"`
}

type LockStackResponse

type LockStackResponse struct {
	AtmosApiResponse
	Data struct {
		ID          string    `json:"id,omitempty"`
		WorkspaceId string    `json:"workspaceId,omitempty"`
		Key         string    `json:"key,omitempty"`
		LockMessage string    `json:"lockMessage,omitempty"`
		ExpiresAt   time.Time `json:"expiresAt,omitempty"`
		CreatedAt   time.Time `json:"createdAt,omitempty"`
		UpdatedAt   time.Time `json:"updatedAt,omitempty"`
		DeletedAt   time.Time `json:"deletedAt,omitempty"`
	} `json:"data"`
}

type UnlockStackRequest

type UnlockStackRequest struct {
	Key string `json:"key"`
}

type UnlockStackResponse

type UnlockStackResponse struct {
	AtmosApiResponse
	Data struct{} `json:"data"`
}

type UploadAffectedStacksRequest

type UploadAffectedStacksRequest struct {
	HeadSHA   string            `json:"head_sha"`
	BaseSHA   string            `json:"base_sha"`
	RepoURL   string            `json:"repo_url"`
	RepoName  string            `json:"repo_name"`
	RepoOwner string            `json:"repo_owner"`
	RepoHost  string            `json:"repo_host"`
	Stacks    []schema.Affected `json:"stacks"`
}

Jump to

Keyboard shortcuts

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