entities

Documentation

Index

• type Api
• type AuthType
• type Key
• type KeyAuth
• type Ratelimit
• type Workspace

Types

type Api

type Api struct {
	Id          string
	Name        string
	WorkspaceId string
	IpWhitelist []string

	AuthType AuthType
	// Only set if AuthType == "key"
	KeyAuthId string
}

type AuthType

type AuthType string

const (
	AuthTypeKey AuthType = "key"
	AuthTypeJWT AuthType = "jwt"
)

type Key

type Key struct {
	Id             string
	KeyAuthId      string
	WorkspaceId    string
	Name           string
	Hash           string
	Start          string
	OwnerId        string
	Meta           map[string]any
	CreatedAt      time.Time
	Expires        time.Time
	Ratelimit      *Ratelimit
	ForWorkspaceId string
	Remaining      struct {
		// Whether or not the value in `Remaining` makes any sense or is just a default
		Enabled   bool
		Remaining int64
	}
}

type KeyAuth

type KeyAuth struct {
	Id          string
	WorkspaceId string
}

type Ratelimit

type Ratelimit struct {
	Type           string
	Limit          int64
	RefillRate     int64
	RefillInterval int64
}

type Workspace

type Workspace struct {
	Id                 string
	Name               string
	Slug               string
	TenantId           string
	Internal           bool
	EnableBetaFeatures bool
}