model

Documentation

Index

• Variables
• type APIErrorResponse
  • func (e *APIErrorResponse) Error() string
• type APIResponse
• type Workspace
• type Workspaces
  • func (w *Workspaces) FindByID(id any) *Workspace

Variables

var (
	// APIErrBadRequest represents an HTTP 400 error
	APIErrBadRequest = errors.New("bad request")
	// APIErrSystemUnavailable represents an hTTP 5xx error
	APIErrSystemUnavailable = errors.New("system unavailable")
	// APIErrUnauthorized represents an HTTP 401 error
	APIErrUnauthorized = errors.New("unauthorized")
)

Types

type APIErrorResponse

type APIErrorResponse struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	Err     error
}

APIErrorResponse represents a body of the shape: {"success":false,"message":"error message"}

func (*APIErrorResponse) Error

func (e *APIErrorResponse) Error() string

Error implements the error interface

type APIResponse

type APIResponse struct {
	Success  bool   `json:"success"`
	Message  string `json:"message"`
	Revision int64  `json:"revision"`
}

APIResponse represents a response from structurizr

type Workspace

type Workspace struct {
	ID           int64  `json:"id"`
	Name         string `json:"name"`
	Description  string `json:"description"`
	APIKey       string `json:"apiKey"`
	APISecret    string `json:"apiSecret"`
	PublicURL    string `json:"publicUrl"`
	PrivateURL   string `json:"privateUrl"`
	ShareableURL string `json:"shareableUrl"`
}

Workspace represents a workspace configured in the structurizr

type Workspaces

type Workspaces struct {
	Workspaces []*Workspace `json:"workspaces"`
}

Workspaces is the response body for any CRU methods

func (*Workspaces) FindByID

func (w *Workspaces) FindByID(id any) *Workspace

FindByID returns a workspace by its ID