api

package
v0.1.0-alpha.1 Latest Latest
Warning

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

Go to latest
Published: Jan 22, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client represents a Nexlayer API client

func NewClient

func NewClient(baseURL string) *Client

NewClient creates a new Nexlayer API client

func (*Client) GetDeploymentInfo

func (c *Client) GetDeploymentInfo(namespace, applicationID string) (*GetDeploymentInfoResponse, error)

GetDeploymentInfo retrieves detailed information about a specific deployment

func (*Client) GetDeployments

func (c *Client) GetDeployments(applicationID string) (*GetDeploymentsResponse, error)

GetDeployments retrieves all deployments for a given application

func (*Client) SaveCustomDomain

func (c *Client) SaveCustomDomain(applicationID string, domain string) (*SaveCustomDomainResponse, error)

SaveCustomDomain saves a custom domain for a deployment

func (*Client) StartDeployment

func (c *Client) StartDeployment(applicationID string, yamlContent []byte) (*StartDeploymentResponse, error)

StartDeployment initiates a new deployment

type DeploymentInfo

type DeploymentInfo struct {
	Namespace        string `json:"namespace"`
	TemplateID       string `json:"templateID"`
	TemplateName     string `json:"templateName"`
	DeploymentStatus string `json:"deploymentStatus"`
}

DeploymentInfo represents information about a deployment

type GetDeploymentInfoResponse

type GetDeploymentInfoResponse struct {
	Deployment DeploymentInfo `json:"deployment"`
}

GetDeploymentInfoResponse represents the response from getDeploymentInfo endpoint

type GetDeploymentsResponse

type GetDeploymentsResponse struct {
	Deployments []DeploymentInfo `json:"deployments"`
}

GetDeploymentsResponse represents the response from getDeployments endpoint

type SaveCustomDomainRequest

type SaveCustomDomainRequest struct {
	Domain string `json:"domain"`
}

SaveCustomDomainRequest represents the request body for saveCustomDomain endpoint

type SaveCustomDomainResponse

type SaveCustomDomainResponse struct {
	Message string `json:"message"`
}

SaveCustomDomainResponse represents the response from saveCustomDomain endpoint

type StartDeploymentResponse

type StartDeploymentResponse struct {
	Message   string `json:"message"`
	Namespace string `json:"namespace"`
	URL       string `json:"url"`
}

StartDeploymentResponse represents the response from startUserDeployment endpoint

Jump to

Keyboard shortcuts

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