rest

README

opslevel-go

opslevel-go is a client library for the OpsLevel integrations API

To get started create a new client:

client := opslevel.NewClient()

Deploys Integration

The Deploys Integration requires the following fields:

deployRequest := opslevel.DeployRequest{
    Service:     "my_service",
    Description: "my_service was deployed",
    Deployer: rest.Deployer{
        Email: "deployer@myapp.com",
    },
    Environment: "env",
    DeployedAt:  time.Now(),
}
err := client.Deploy(deployRequest, "my-integration-uuid")

For a full list fields, see the docs.

Checks Integration

The Deploys Integration requires the following fields:

checkRequest := CheckRequest{
    Service: "my_service",
    Check:   "my_check",
    Message: "Checks passed",
    Status:  "passed",
}
err := client.Check(checkRequest, "my-integration-uuid")

The Message field is optional and Status should be one of passed or failed.

Documentation

Index

• type CheckRequest
• type Client
  • func NewClient() *Client
  • func (c *Client) Check(req CheckRequest, integrationID string) error
  • func (c *Client) Deploy(req DeployRequest, integrationID string) error
• type Commit
• type DeployRequest
• type Deployer

Types

type CheckRequest

type CheckRequest struct {
	Service string `validate:"required" json:"service"`
	Check   string `validate:"required" json:"check"`
	Status  string `validate:"required,oneof=passed failed" json:"status"`
	Message string `json:"message"`
}

CheckRequest represents a structured request to the OpsLevel checks webhook endpoint

type Client

type Client struct {
	Logger *log.Logger
	// contains filtered or unexported fields
}

Client represents a rest http client and is used to send requests to OpsLevel integrations

func NewClient

func NewClient() *Client

NewClient returns a Client pointer

func (*Client) Check

func (c *Client) Check(req CheckRequest, integrationID string) error

Check sends a CheckRequest to the OpsLevel deploy integration at integrationID

func (*Client) Deploy

func (c *Client) Deploy(req DeployRequest, integrationID string) error

Deploy sends a DeployRequest to the OpsLevel deploy integration at integrationID

type Commit

type Commit struct {
	SHA            string    `json:"sha"`
	Message        string    `json:"message"`
	Branch         string    `json:"branch"`
	Date           time.Time `json:"date"`
	CommitterName  string    `json:"committer_name"`
	CommitterEmail string    `json:"committer_email"`
	AuthorName     string    `json:"author_name"`
	AuthorEmail    string    `json:"author_email"`
	AuthoringDate  time.Time `json:"authoring_date"`
}

Commit represents the commit being deployed

type DeployRequest

type DeployRequest struct {
	Service      string    `validate:"required" json:"service"`
	Deployer     Deployer  `validate:"required" json:"deployer"`
	DeployedAt   time.Time `validate:"required" json:"deployed_at"`
	Description  string    `validate:"required" json:"description"`
	Environment  string    `json:"environment"`
	DeployURL    string    `json:"deploy_url"`
	DeployNumber string    `json:"deploy_number"`
	Commit       Commit    `json:"commit"`
}

DeployRequest represents a structured request to the OpsLevel deploys webhook endpoint

type Deployer

type Deployer struct {
	Email string `validate:"required" json:"email"`
	Name  string `json:"name"`
}

Deployer represents the entity taking the action