environments

Documentation

Index

• Constants
• func AddRoutes(sg *echo.Group)
• func SyncHandler(c echo.Context) error
• func SyncWithPasswordHandler(c echo.Context) error
• func ValidateInputHandler(c echo.Context) error
• type SyncOptions
• type SyncWithPasswordOptions

Constants

const (
	ENV_ID = "env_id"
)

const FREE_TIER_LIMIT_NUMBER_OF_ENVIRONMENTS = 4

Functions

func AddRoutes

func AddRoutes(sg *echo.Group)

func SyncHandler

func SyncHandler(c echo.Context) error

func SyncWithPasswordHandler

func SyncWithPasswordHandler(c echo.Context) error

--- Flow ---

1. Get the organisation ID linked to this environment.
2. Decrypt the organisation's encryption key.
3. Fetch the secrets of this environment. - Fetch the latest version if no version is specified in request payload.
4. Decrypt the secrets using organisation's encryption key.
5. Fetch the events linked to this environment.
6. Call the integration service for each of the events to sync the secrets.

func ValidateInputHandler

func ValidateInputHandler(c echo.Context) error

Types

type SyncOptions

type SyncOptions struct {
	EventIDs []string          `json:"event_ids,omitempty"`
	Pairs    *keypayload.KPMap `json:"pairs"`
}

type SyncWithPasswordOptions

type SyncWithPasswordOptions struct {
	EventIDs []string
	Password string `json:"password" validate:"required"`
	Version  *int   `json:"version,omitempty"`

	// Name of the secret to sync.
	Key string `json:"key,omitempty"`
}