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.
CiStatus
A CI status.
CreatePullRequest
The body of POST /repos/{repo_ref}/pullreq.
Execution
One run of a pipeline.
FileDiff
One file’s worth of a pull request diff.
LogLine
One line of step output.
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.
PullRequest
A pull request.
PullRequestCheck
PullRequestChecks
PullRequestStats
RepoRef
A reference to a repository, e.g. ai/backend.
Repository
A repository.
Stage
Step
One step of a stage — the unit logs are addressed by.
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