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.
- Check
Count Summary - How many checks on the head commit are in each state.
- CiStatus
- A CI status.
- Code
Comment - 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.
- Content
Entry - One entry of a directory listing.
- Create
Gitspace - The body of
POST /api/v1/gitspaces. - Create
Pull Request - The body of
POST /repos/{repo_ref}/pullreq. - Create
Repository - The body of
POST /api/v1/repos. - Execution
- One run of a pipeline.
- File
Diff - One file’s worth of a pull request diff.
- Gitspace
- A gitspace — GitFox’s cloud development environment.
- Gitspace
Instance - Identity
- Label
- A label defined on a repository or a space.
- Label
Assignment - Label
Input - The body for defining or updating a label. Every field is optional on an
update;
keyrenames the label. - Label
Value - Label
Value Info - License
Template - 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.
- Merge
Pull Request - The body of
POST /repos/{repo_ref}/pullreq/{n}/merge. - Merge
Result - The answer to a merge attempt.
- Pipeline
- A pipeline definition.
executionis its latest run, present only when the list was asked for withlatest=true. - Principal
- A user or service account, as GitFox reports it inside other resources.
- Public
Key - An SSH public key on the caller’s account.
- Pull
Request - A pull request.
- Pull
Request Activity - 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.
- Pull
Request Check - Pull
Request Checks - Pull
Request Label - A label as it is attached to a pull request: the label’s key and, for a label with values, the value chosen.
- Pull
Request Labels GET …/pullreq/{n}/labels: the labels that can be, or are, attached.- Pull
Request Reviewer - A reviewer on a pull request, and where their review stands.
- Pull
Request Stats - 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.
- Space
Secret - A secret stored in a space. GitFox never returns the value.
- Stage
- Step
- One step of a stage — the unit logs are addressed by.
- System
Config GET /api/v1/system/config— what this instance has switched on.- Update
Pull Request - 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§
- Merge
Method - How a pull request is merged. The wire values are GitFox’s, including the
hyphen in
fast-forward. - Pull
Request State - Review
Decision - 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
#.