Skip to main content

Module models

Module models 

Source
Expand description

Domain models owned by the client.

These are deliberately not the raw GitFox API DTOs: keeping a translation layer means an upstream API change is absorbed by a serde attribute here instead of leaking into the CLI’s stable JSON schema.

Structs§

Check
A status check reported against a pull request’s head commit.
CheckCountSummary
How many checks on the head commit are in each state.
CiStatus
A CI status.
CodeComment
Where a code comment is anchored.
Commit
A commit, as GitFox reports it in commit and pull request listings.
Content
A path in a repository at some ref: a file, a directory, a symlink or a submodule.
ContentEntry
One entry of a directory listing.
CreateGitspace
The body of POST /api/v1/gitspaces.
CreatePullRequest
The body of POST /repos/{repo_ref}/pullreq.
CreateRepository
The body of POST /api/v1/repos.
Execution
One run of a pipeline.
FileDiff
One file’s worth of a pull request diff.
Gitspace
A gitspace — GitFox’s cloud development environment.
GitspaceInstance
Identity
Label
A label defined on a repository or a space.
LabelAssignment
LabelInput
The body for defining or updating a label. Every field is optional on an update; key renames the label.
LabelValue
LabelValueInfo
LicenseTemplate
One entry of GET /api/v1/resources/license.
LogLine
One line of step output.
Membership
A space the caller belongs to, and in what role.
MergePullRequest
The body of POST /repos/{repo_ref}/pullreq/{n}/merge.
MergeResult
The answer to a merge attempt.
Pipeline
A pipeline definition. execution is its latest run, present only when the list was asked for with latest=true.
Principal
A user or service account, as GitFox reports it inside other resources.
PublicKey
An SSH public key on the caller’s account.
PullRequest
A pull request.
PullRequestActivity
One entry in a pull request’s timeline: a comment, a code comment, or a system event such as a merge or a title change.
PullRequestCheck
PullRequestChecks
PullRequestLabel
A label as it is attached to a pull request: the label’s key and, for a label with values, the value chosen.
PullRequestLabels
GET …/pullreq/{n}/labels: the labels that can be, or are, attached.
PullRequestReviewer
A reviewer on a pull request, and where their review stands.
PullRequestStats
RepoRef
A reference to a repository, e.g. ai/backend.
Repository
A repository.
Rule
A protection rule on a repository.
Signature
Space
A space — GitFox’s organisation, which can nest.
SpaceSecret
A secret stored in a space. GitFox never returns the value.
Stage
Step
One step of a stage — the unit logs are addressed by.
SystemConfig
GET /api/v1/system/config — what this instance has switched on.
UpdatePullRequest
The body of PATCH /repos/{repo_ref}/pullreq/{n}. GitFox edits only the title and the description here; everything else has its own endpoint.
User
The authenticated principal, as reported by GET /api/v1/user.

Enums§

MergeMethod
How a pull request is merged. The wire values are GitFox’s, including the hyphen in fast-forward.
PullRequestState
ReviewDecision
What a review says. The wire values are GitFox’s.

Constants§

LABEL_COLORS
The colours GitFox accepts, with the RGB each one is drawn as — used to map a hex colour from a GitHub-style command onto the nearest name.

Functions§

decode_base64
Standard base64, tolerant of line breaks. Kept here rather than pulling in a crate for the one place GitFox sends it.
encode_base64
Standard base64 with padding.
label_color
A colour name GitFox accepts, from either a name or a hex triplet.
label_color_hex
The hex triplet a palette name is drawn as, without #.