reviewsession

package
v0.2.1 Latest Latest
Warning

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

Go to latest
Published: Oct 26, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DiffScopes          = "diff.scopes"
	DiffRefresh         = "diff.refresh"
	DiffStagingMetadata = "diff.stagingMetadata"
	FilesContents       = "files.contents"
	ReviewComments      = "review.comments"
)

Variables

This section is empty.

Functions

func NotEnabled

func NotEnabled(capability string) error

Types

type Capabilities

type Capabilities struct {
	Diff   DiffCapabilities   `json:"diff"`
	Files  FileCapabilities   `json:"files"`
	Review ReviewCapabilities `json:"review"`
}

func ResolveCapabilities

func ResolveCapabilities(support review.Support, policies Policies) Capabilities

ResolveCapabilities is shared by catalog metadata and resolved review sessions. Capabilities describe source support and policy, never the deployment mode.

type Capability

type Capability struct {
	State State `json:"state"`
}

func (Capability) Enabled

func (capability Capability) Enabled() bool

type CapabilityError

type CapabilityError struct {
	Capability string
}

func (*CapabilityError) Error

func (err *CapabilityError) Error() string

type DiffCapabilities

type DiffCapabilities struct {
	Scopes          ScopesCapability `json:"scopes"`
	Refresh         Capability       `json:"refresh"`
	StagingMetadata Capability       `json:"stagingMetadata"`
}

type FileCapabilities

type FileCapabilities struct {
	Contents Capability `json:"contents"`
}

type Policies

type Policies struct {
	Comments Policy
}

type Policy

type Policy string
const (
	Auto          Policy = "auto"
	DisablePolicy Policy = "disabled"
)

type ReviewCapabilities

type ReviewCapabilities struct {
	Comments Capability `json:"comments"`
}

type ScopesCapability

type ScopesCapability struct {
	State  State             `json:"state"`
	Values []review.DiffMode `json:"values"`
}

func (ScopesCapability) Allows

func (capability ScopesCapability) Allows(mode review.DiffMode) bool

type Session

type Session struct {
	ID           string
	User         User
	ContextID    string
	LocationID   *string
	RepositoryID *string
	DiffIDs      map[review.DiffMode]string
	Source       review.Source
	Capabilities Capabilities
}

func Resolve

func Resolve(source review.Source, policies Policies) Session

type State

type State string
const (
	Enabled     State = "enabled"
	Disabled    State = "disabled"
	Unavailable State = "unavailable"
)

type User

type User struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

Jump to

Keyboard shortcuts

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