reference

package
v1.260325.0 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKeyNotes

type APIKeyNotes struct {
	Team       TeamKeyNotes       `json:"team_keys"`
	Individual IndividualKeyNotes `json:"individual_keys"`
}

type CapabilityGroup

type CapabilityGroup struct {
	ID      string `json:"id"`
	Label   string `json:"label"`
	Summary string `json:"summary,omitempty"`
}

type DocumentedAccess

type DocumentedAccess struct {
	ID         string   `json:"id"`
	Label      string   `json:"label"`
	Summary    string   `json:"summary,omitempty"`
	Roles      []string `json:"roles,omitempty"`
	RoleLabels []string `json:"roleLabels,omitempty"`
}

type IndividualKeyNotes

type IndividualKeyNotes struct {
	EligibleUserRoles           []string `json:"eligible_user_roles"`
	OneActiveKeyPerUser         bool     `json:"one_active_key_per_user"`
	DefaultGenerationPermission string   `json:"default_generation_permission"`
	ManageableBy                []string `json:"manageable_by"`
}

type KeyNotes

type KeyNotes struct {
	Kind                        string   `json:"kind"`
	RequiredCreatorRoles        []string `json:"requiredCreatorRoles,omitempty"`
	SelectableRoles             []string `json:"selectableRoles,omitempty"`
	EditableAfterCreation       *bool    `json:"editableAfterCreation,omitempty"`
	EligibleUserRoles           []string `json:"eligibleUserRoles,omitempty"`
	OneActiveKeyPerUser         *bool    `json:"oneActiveKeyPerUser,omitempty"`
	DefaultGenerationPermission string   `json:"defaultGenerationPermission,omitempty"`
	ManageableBy                []string `json:"manageableBy,omitempty"`
}

type Role

type Role struct {
	Code                  string   `json:"code"`
	Label                 string   `json:"label"`
	UIAliases             []string `json:"ui_aliases,omitempty"`
	TeamKeySelectable     bool     `json:"team_key_selectable"`
	IndividualKeyEligible bool     `json:"individual_key_eligible"`
	Summary               string   `json:"summary,omitempty"`
	Capabilities          []string `json:"capabilities,omitempty"`
	Notes                 []string `json:"notes,omitempty"`
	ExampleTasks          []string `json:"example_tasks,omitempty"`
	NotableActions        []string `json:"notable_exclusive_actions,omitempty"`
}

type Scope

type Scope struct {
	AppliesToAllApps bool   `json:"appliesToAllApps,omitempty"`
	Summary          string `json:"summary,omitempty"`
}

type Snapshot

type Snapshot struct {
	LastVerified string            `json:"last_verified"`
	Purpose      string            `json:"purpose"`
	Limitations  []string          `json:"limitations,omitempty"`
	Sources      []Source          `json:"sources"`
	APIKeyNotes  APIKeyNotes       `json:"api_key_notes"`
	Groups       []CapabilityGroup `json:"capability_groups"`
	Roles        []Role            `json:"roles"`
}

func Load

func Load() (*Snapshot, error)

type Source

type Source struct {
	Title string `json:"title"`
	URL   string `json:"url"`
}

type TeamKeyNotes

type TeamKeyNotes struct {
	RequiredCreatorRoles []string `json:"required_creator_roles"`
	TeamScope            string   `json:"team_scope"`
	EditableAfterCreate  bool     `json:"editable_after_creation"`
	SelectableRoles      []string `json:"selectable_roles"`
}

type View

type View struct {
	LastVerified     string             `json:"lastVerified"`
	Purpose          string             `json:"purpose,omitempty"`
	Sources          []Source           `json:"sources,omitempty"`
	Scope            *Scope             `json:"scope,omitempty"`
	KeyNotes         *KeyNotes          `json:"keyNotes,omitempty"`
	RoleDetails      []Role             `json:"roleDetails,omitempty"`
	Capabilities     []CapabilityGroup  `json:"capabilities,omitempty"`
	DocumentedAccess []DocumentedAccess `json:"documentedAccess,omitempty"`
	UnknownRoles     []string           `json:"unknownRoles,omitempty"`
	Limitations      []string           `json:"limitations,omitempty"`
}

func Resolve

func Resolve(kind string, codes []string) (*View, error)

Jump to

Keyboard shortcuts

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