actionrequests

type Action struct {
	// ID is the canonical action ID, which a finding is filed under.
	ID string
	// Name is the action name its spec declares, which a construction site
	// is found by.
	Name string
	// Owner is the package the catalog names as the action's owner.
	Owner string
	// Tool is the individual tool name the action projects, which tells apart
	// two sites declaring one name in one package. It is "" for an action the
	// individual surface does not publish.
	Tool string
	// ReadOnly is the catalog's classification of the action.
	ReadOnly bool
	// Group is the tool name of the catalog group the action belongs to,
	// which the scopes a group demands are keyed by.
	Group string
}

type DocumentUse struct {
	// Text is the document as GitLab receives it, fragments spliced in.
	Text string
	// Name is the constant or variable the document was declared as, or ""
	// when it is written inline at the point of use.
	Name string
	// Pos is where the body names it, which is the line inside the handler a
	// reader has to change, and so the line a finding points at.
	Pos token.Pos
}

type Function struct {
	// Documents is every GraphQL document this body names.
	Documents []DocumentUse
	// SendsGraphQL reports whether this body reaches the GraphQL transport,
	// which is what makes a document it names a request rather than a string.
	SendsGraphQL bool
	// SDKMethods is every client-go service method this body names, as
	// "Service.Method", sorted. A method value handed to a helper counts, for
	// the reason a function reference counts as a call.
	SDKMethods []string
	// contains filtered or unexported fields
}

type Handler struct {
	// Func is the declared function, or nil for a literal.
	Func *types.Func
	// Lit is the literal, or nil for a declared function.
	Lit *ast.FuncLit
	// contains filtered or unexported fields
}

type Program struct {
	// contains filtered or unexported fields
}

type Record struct {
	Note    string         `json:"note"`
	Actions []RecordAction `json:"actions"`
}

type RecordAction struct {
	ID       string   `json:"id"`
	Handlers []string `json:"handlers"`
	// Declaration is the category of the action-level declaration that
	// answers what the walk could not, when one does.
	Declaration string `json:"declaration,omitempty"`
	// Classic is the classic scope the action needs, as
	// finegrained.ClassicScope spells it, and GroupScopes the scopes its
	// catalog group demands besides (admin_mode), which the server's scope
	// filter decides per group.
	Classic     string          `json:"classic"`
	GroupScopes []string        `json:"group_scopes,omitempty"`
	Requests    []RecordRequest `json:"requests,omitempty"`
	// Paths are the ways the action runs, as indices into Requests.
	Paths [][]int `json:"paths"`
}

type RecordRequest struct {
	// Kind is one of the Kind constants.
	Kind string `json:"kind"`
	// Route is a REST request's route as the live record spells it, and
	// Derived the derivation's spelling where a declaration placed it.
	Route   string `json:"route,omitempty"`
	Derived string `json:"derived,omitempty"`
	// Operation, RootFields and Positions describe a GraphQL request.
	Operation  string   `json:"operation,omitempty"`
	RootFields []string `json:"root_fields,omitempty"`
	Positions  []string `json:"positions,omitempty"`
	// Reason names an unresolved request's class and subject.
	Reason string `json:"reason,omitempty"`
	// Class is one of the Class constants.
	Class string `json:"class"`
	// Classic is the classic scope GitLab requires for the request, as
	// finegrained.ClassicScope spells it, and ClassicDeclaration the category
	// of what departed from GitLab's general rule to decide it, when
	// something did.
	Classic            string   `json:"classic"`
	ClassicDeclaration string   `json:"classic_declaration,omitempty"`
	Sites              []string `json:"sites,omitempty"`
	SDKMethods         []string `json:"sdk_methods,omitempty"`
	// Directives are the //gitlab:request directives that qualified it, as
	// "<kind>: <reason>".
	Directives []string `json:"directives,omitempty"`
	// Declaration is the category of the declaration that supplied it.
	Declaration string `json:"declaration,omitempty"`
}

type Site struct {
	// Package is the name of the package the construction is written in.
	Package string
	// Name is the action name it declares.
	Name string
	// Tool is the individual tool name its options declare, or "" when the
	// options could not be followed to one. It is what joins a site to one
	// canonical ID where two sites share a name: the project and group badge
	// actions are declared by one package under one set of names.
	Tool string
	// Handlers is every function its route runs.
	Handlers []Handler
	// Pos is where the construction is written.
	Pos token.Pos
}