sailfork / sdk / openapi.json

{
  "components": {
    "schemas": {
      "AffectedMode": {
        "description": "How much of the checks a change must run.",
        "enum": [
          "selective",
          "everything",
          "nothing",
          "unknown"
        ],
        "type": "string"
      },
      "AffectedStep": {
        "properties": {
          "command": {
            "type": "string"
          },
          "dir": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "targets": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "kind",
          "dir",
          "targets",
          "command"
        ],
        "type": "object"
      },
      "AgentTrackingState": {
        "description": "Whether the account's agent work is tracked.",
        "properties": {
          "enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "enabled"
        ],
        "type": "object"
      },
      "Annotation": {
        "description": "A note on lines of a file.",
        "properties": {
          "endLine": {
            "format": "uint32",
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "level": {
            "description": "`notice`, `warning` or `failure`.",
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "startLine": {
            "format": "uint32",
            "minimum": 0,
            "type": "integer"
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "path",
          "startLine",
          "level",
          "message"
        ],
        "type": "object"
      },
      "ApiError": {
        "description": "The error body every non-2xx response carries.",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "docUrl": {
            "description": "Where the code is documented.",
            "type": "string"
          },
          "error": {
            "description": "The message. Its wording can change; match on `code`.",
            "type": "string"
          },
          "hint": {
            "description": "What a caller can do about it.",
            "type": [
              "string",
              "null"
            ]
          },
          "param": {
            "description": "The field or scope the error is about.",
            "type": [
              "string",
              "null"
            ]
          },
          "requestId": {
            "description": "Quote it when reporting a problem; also the `Sailfork-Request-Id` response header.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "error",
          "code",
          "docUrl"
        ],
        "type": "object"
      },
      "Artifacts": {
        "description": "`GET runs/{id}/artifacts`.",
        "properties": {
          "artifacts": {
            "items": {
              "$ref": "#/components/schemas/RunArtifact"
            },
            "type": "array"
          }
        },
        "required": [
          "artifacts"
        ],
        "type": "object"
      },
      "AskKind": {
        "description": "How a person answers an [`IssueAsk`]: `single` (one option), `multi` (any number of options) or `text` (free text).",
        "enum": [
          "single",
          "multi",
          "text"
        ],
        "type": "string"
      },
      "AskOptionInput": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "$ref": "#/components/schemas/IssueAskOption"
          }
        ],
        "description": "An option as an asker writes it: its label alone, or the label with a description."
      },
      "AutoMerge": {
        "description": "A pull request's auto-merge: `GET`, `PUT` and `DELETE pulls/{n}/auto-merge`.",
        "properties": {
          "by": {
            "default": null,
            "description": "Who turned it on; the merge is made as them.",
            "type": [
              "string",
              "null"
            ]
          },
          "deleteBranch": {
            "default": null,
            "type": [
              "boolean",
              "null"
            ]
          },
          "enabled": {
            "type": "boolean"
          },
          "expectedHead": {
            "default": null,
            "type": [
              "string",
              "null"
            ]
          },
          "merged": {
            "default": false,
            "description": "The call merged it: its checks had passed and the rules allowed it.",
            "type": "boolean"
          },
          "method": {
            "default": null,
            "type": [
              "string",
              "null"
            ]
          },
          "position": {
            "default": null,
            "description": "Its place among the queued pull requests (1 lands next).",
            "format": "int64",
            "type": [
              "integer",
              "null"
            ]
          },
          "queued": {
            "default": false,
            "description": "It waits in the repository's merge queue, which lands it when it is ready, rather than merging by itself.",
            "type": "boolean"
          },
          "since": {
            "default": null,
            "type": [
              "string",
              "null"
            ]
          },
          "waiting": {
            "default": null,
            "description": "Why it has not merged yet.",
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "enabled",
          "merged",
          "queued",
          "position",
          "waiting",
          "expectedHead",
          "method",
          "deleteBranch",
          "by",
          "since"
        ],
        "type": "object"
      },
      "BatchItem": {
        "description": "One issue of a batch. `{{ref}}` of another item in `title` or `body` becomes `#<number>`.",
        "properties": {
          "assignee": {
            "type": [
              "string",
              "null"
            ]
          },
          "blockedBy": {
            "items": {
              "$ref": "#/components/schemas/ItemRef"
            },
            "type": "array"
          },
          "body": {
            "default": "",
            "type": "string"
          },
          "due": {
            "type": [
              "string",
              "null"
            ]
          },
          "estimate": {
            "format": "uint8",
            "maximum": 255,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "labels": {
            "default": [],
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "milestone": {
            "type": [
              "string",
              "null"
            ]
          },
          "parent": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ItemRef"
              },
              {
                "type": "null"
              }
            ]
          },
          "priority": {
            "$ref": "#/components/schemas/IssuePriority",
            "default": "none"
          },
          "ref": {
            "description": "A name other items use to point at this one.",
            "type": "string"
          },
          "stage": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/IssueStage"
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "ref",
          "title"
        ],
        "type": "object"
      },
      "BranchUpdated": {
        "description": "The answer of `POST pulls/{n}/update-branch` and `POST pulls/{n}/conflicts`.",
        "properties": {
          "headSha": {
            "type": [
              "string",
              "null"
            ]
          },
          "updated": {
            "type": "boolean"
          }
        },
        "required": [
          "headSha",
          "updated"
        ],
        "type": "object"
      },
      "Caisson": {
        "properties": {
          "adopted": {
            "description": "Commits pushed to the branch from elsewhere that the caisson has built on.",
            "format": "uint32",
            "minimum": 0,
            "type": "integer"
          },
          "ask": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CaissonAsk"
              },
              {
                "type": "null"
              }
            ]
          },
          "base": {
            "$ref": "#/components/schemas/CaissonBase"
          },
          "branch": {
            "type": "string"
          },
          "branchDeleted": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "commits": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/PullCommit"
            },
            "type": "array"
          },
          "files": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/PullFile"
            },
            "type": "array"
          },
          "forked": {
            "type": [
              "string",
              "null"
            ]
          },
          "forkedFrom": {
            "type": [
              "string",
              "null"
            ]
          },
          "id": {
            "type": "string"
          },
          "openedAt": {
            "type": "string"
          },
          "openedBy": {
            "$ref": "#/components/schemas/Opener"
          },
          "pull": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CaissonPull"
              },
              {
                "type": "null"
              }
            ]
          },
          "refused": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CaissonRefused"
              },
              {
                "type": "null"
              }
            ],
            "default": null
          },
          "repo": {
            "type": "string"
          },
          "scope": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "session": {
            "default": [],
            "items": {
              "$ref": "#/components/schemas/SessionStep"
            },
            "type": "array"
          },
          "skippedForks": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "state": {
            "type": "string"
          },
          "stopped": {
            "type": [
              "string",
              "null"
            ]
          },
          "stoppedForks": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "title": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "repo",
          "openedBy",
          "title",
          "branch",
          "base",
          "state",
          "openedAt",
          "updatedAt",
          "scope",
          "pull",
          "ask",
          "refused",
          "stopped",
          "files",
          "commits",
          "session"
        ],
        "type": "object"
      },
      "CaissonAffected": {
        "description": "The test and build steps a caisson's changes affect.",
        "properties": {
          "changed": {
            "description": "How many files changed.",
            "format": "uint64",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "$ref": "#/components/schemas/AffectedMode"
          },
          "reason": {
            "type": "string"
          },
          "script": {
            "description": "Shell that runs the steps one after another and exits with the last failure; empty when no step runs.",
            "type": "string"
          },
          "skipped": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "steps": {
            "items": {
              "$ref": "#/components/schemas/AffectedStep"
            },
            "type": "array"
          },
          "summary": {
            "type": "string"
          },
          "unowned": {
            "description": "Changed files that made the selection widen to everything.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "mode",
          "reason",
          "changed",
          "steps",
          "skipped",
          "unowned",
          "script",
          "summary"
        ],
        "type": "object"
      },
      "CaissonAsk": {
        "properties": {
          "path": {
            "type": "string"
          },
          "why": {
            "type": "string"
          }
        },
        "required": [
          "path",
          "why"
        ],
        "type": "object"
      },
      "CaissonAstMatch": {
        "description": "One place an ast-grep pattern matched.",
        "properties": {
          "captures": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "What each metavariable of the pattern captured, by name without the `

	
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
		
	openapi.json at main · sailfork/sdk · Sailfork
	
		
.", "type": "object" }, "endLine": { "format": "uint64", "minimum": 0, "type": "integer" }, "line": { "description": "The first line of the match, from 1.", "format": "uint64", "minimum": 0, "type": "integer" }, "path": { "type": "string" }, "text": { "description": "The matched code, cut at 400 bytes.", "type": "string" } }, "required": [ "path", "line", "endLine", "text", "captures" ], "type": "object" }, "CaissonAstMatches": { "description": "What a structural search found.", "properties": { "matches": { "items": { "$ref": "#/components/schemas/CaissonAstMatch" }, "type": "array" }, "skipped": { "description": "Files left out for being over 1 MiB or not text.", "items": { "type": "string" }, "type": "array" }, "truncated": { "description": "More matches exist than `limit`, or the search stopped at its time or size limit.", "type": "boolean" } }, "required": [ "matches", "skipped", "truncated" ], "type": "object" }, "CaissonBase": { "properties": { "branch": { "type": "string" }, "sha": { "type": "string" } }, "required": [ "branch", "sha" ], "type": "object" }, "CaissonBashResult": { "description": "How a bash run ended and what it changed.", "properties": { "changes": { "description": "What the script changed, as a batch reports it.", "items": { "$ref": "#/components/schemas/CaissonChanged" }, "type": "array" }, "dryRun": { "type": "boolean" }, "exitCode": { "format": "int32", "type": "integer" }, "held": { "description": "Set when the changes are held for a person to approve." }, "limit": { "description": "The limit that stopped the run (time, output, memory), when one did.", "type": [ "string", "null" ] }, "notSaved": { "description": "Why nothing was saved, when the script's changes were dropped.", "type": [ "string", "null" ] }, "rule": { "description": "The path rule that refused the changes." }, "saved": { "description": "Whether the files the script changed were written to the caisson.", "type": "boolean" }, "skipped": { "items": { "type": "string" }, "type": "array" }, "stderr": { "type": "string" }, "stderrTruncated": { "type": "boolean" }, "stdout": { "type": "string" }, "stdoutTruncated": { "type": "boolean" } }, "required": [ "exitCode", "stdout", "stderr", "stdoutTruncated", "stderrTruncated", "limit", "dryRun", "saved", "changes", "skipped" ], "type": "object" }, "CaissonBatchResult": { "description": "The answer of a batch.", "properties": { "changes": { "items": { "$ref": "#/components/schemas/CaissonChanged" }, "type": "array" }, "dryRun": { "type": "boolean" }, "skipped": { "items": { "type": "string" }, "type": "array" } }, "required": [ "dryRun", "changes" ], "type": "object" }, "CaissonChange": { "description": "One file a caisson changes, as a list row draws it.", "properties": { "added": { "format": "uint32", "minimum": 0, "type": "integer" }, "addedBytes": { "format": "uint64", "minimum": 0, "type": "integer" }, "path": { "type": "string" }, "removed": { "format": "uint32", "minimum": 0, "type": "integer" }, "status": { "description": "`added`, `modified`, `deleted` or `renamed`.", "type": "string" } }, "required": [ "path", "status", "added", "removed", "addedBytes" ], "type": "object" }, "CaissonChangeRequest": { "additionalProperties": false, "description": "One change in a batch: set exactly one of `edits`, `content`, `delete`, `moveTo` or `restore`.", "properties": { "content": { "description": "The whole new content of the file, created if it is missing.", "type": [ "string", "null" ] }, "delete": { "description": "Delete the file.", "type": "boolean" }, "edits": { "description": "Edits applied in order to the file as it stands.", "items": { "$ref": "#/components/schemas/CaissonEdit" }, "type": [ "array", "null" ] }, "moveTo": { "description": "Move the file to this path.", "type": [ "string", "null" ] }, "overwrite": { "description": "With `moveTo`: replace a file that is already there.", "type": "boolean" }, "path": { "description": "The file the change is about; with `moveTo`, the file that moves.", "type": "string" }, "restore": { "description": "Drop the caisson's change to the file and go back to the base.", "type": "boolean" } }, "required": [ "path" ], "type": "object" }, "CaissonChanged": { "description": "What one change did.", "properties": { "action": { "description": "`edited`, `written`, `deleted`, `moved`, `restored` or `withdrawn`.", "type": "string" }, "diff": { "type": "string" }, "from": { "type": [ "string", "null" ] }, "oid": { "type": [ "string", "null" ] }, "path": { "type": "string" }, "size": { "format": "uint64", "minimum": 0, "type": "integer" } }, "required": [ "path", "action", "oid", "size", "diff" ], "type": "object" }, "CaissonCommitted": { "description": "One commit on a caisson's branch.", "properties": { "agent": { "type": "boolean" }, "at": { "type": "string" }, "author": { "type": "string" }, "sha": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "sha", "subject", "author", "agent", "at" ], "type": "object" }, "CaissonEdit": { "additionalProperties": false, "description": "One edit to a text file: an exact replacement (`old` and `new`), a regex replacement (`regex` and `new`), or\nlines inserted (`insertAfter` and `text`).", "properties": { "all": { "description": "Replace every match instead of requiring exactly one.", "type": "boolean" }, "insertAfter": { "description": "Insert `text` after this line; 0 is the top of the file.", "format": "uint", "minimum": 0, "type": [ "integer", "null" ] }, "new": { "description": "The replacement. With `regex` it may use `$1` and `${name}`.", "type": [ "string", "null" ] }, "old": { "description": "The text to replace; it must occur exactly once unless `all`.", "type": [ "string", "null" ] }, "regex": { "description": "A regular expression that must match at least once, and exactly once unless `all`.", "type": [ "string", "null" ] }, "text": { "description": "The lines to insert; a newline is added when it lacks one.", "type": [ "string", "null" ] } }, "type": "object" }, "CaissonFileRead": { "anyOf": [ { "properties": { "lines": { "description": "`START-END/TOTAL`, the lines returned of the file's total.", "type": "string" }, "oid": { "type": "string" }, "path": { "type": "string" }, "text": { "type": "string" } }, "required": [ "path", "oid", "lines", "text" ], "type": "object" }, { "properties": { "error": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "error" ], "type": "object" } ], "description": "One file of a multi-file read: its text, or why it could not be read." }, "CaissonFilesRead": { "properties": { "files": { "items": { "$ref": "#/components/schemas/CaissonFileRead" }, "type": "array" } }, "required": [ "files" ], "type": "object" }, "CaissonGlob": { "properties": { "paths": { "items": { "type": "string" }, "type": "array" }, "truncated": { "type": "boolean" } }, "required": [ "paths", "truncated" ], "type": "object" }, "CaissonGrep": { "properties": { "counts": { "items": { "$ref": "#/components/schemas/CaissonGrepCount" }, "type": [ "array", "null" ] }, "files": { "items": { "type": "string" }, "type": [ "array", "null" ] }, "indexed": { "default": false, "type": "boolean" }, "matches": { "items": { "$ref": "#/components/schemas/CaissonGrepMatch" }, "type": [ "array", "null" ] }, "mode": { "type": "string" }, "notSearched": { "items": { "type": "string" }, "type": "array" }, "searched": { "format": "uint64", "minimum": 0, "type": "integer" }, "skipped": { "items": { "type": "string" }, "type": "array" }, "truncated": { "type": "boolean" } }, "required": [ "mode", "searched", "skipped", "truncated", "indexed" ], "type": "object" }, "CaissonGrepCount": { "properties": { "count": { "format": "uint64", "minimum": 0, "type": "integer" }, "path": { "type": "string" } }, "required": [ "path", "count" ], "type": "object" }, "CaissonGrepLine": { "properties": { "line": { "format": "uint64", "minimum": 0, "type": "integer" }, "text": { "type": "string" } }, "required": [ "line", "text" ], "type": "object" }, "CaissonGrepMatch": { "properties": { "after": { "items": { "$ref": "#/components/schemas/CaissonGrepLine" }, "type": "array" }, "before": { "items": { "$ref": "#/components/schemas/CaissonGrepLine" }, "type": "array" }, "line": { "format": "uint64", "minimum": 0, "type": "integer" }, "path": { "type": "string" }, "text": { "type": "string" } }, "required": [ "path", "line", "text", "before", "after" ], "type": "object" }, "CaissonLocated": { "description": "A caisson found by its id alone, with the owner its other routes go under.", "properties": { "ask": { "anyOf": [ { "$ref": "#/components/schemas/CaissonAsk" }, { "type": "null" } ], "description": "The write a person has to approve before the caisson goes on." }, "base": { "$ref": "#/components/schemas/CaissonBase" }, "branch": { "type": "string" }, "canWrite": { "description": "Whether the reader may write, stop it and answer its asks: false for guests and people without push access.", "type": "boolean" }, "forkedFrom": { "description": "The caisson this one was forked from.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "openedAt": { "type": "string" }, "openedBy": { "$ref": "#/components/schemas/Opener" }, "owner": { "description": "The handle of the org or user the caisson is under.", "type": "string" }, "pull": { "anyOf": [ { "$ref": "#/components/schemas/CaissonPull" }, { "type": "null" } ] }, "refused": { "anyOf": [ { "$ref": "#/components/schemas/CaissonRefused" }, { "type": "null" } ], "description": "The latest answer to a held write when it was a refusal and nothing has been written since." }, "repo": { "description": "The repository's name.", "type": "string" }, "scope": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "`live`, `merged`, `stopped` or `closed`.", "type": "string" }, "stopped": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "owner", "id", "repo", "openedBy", "title", "branch", "base", "state", "openedAt", "updatedAt", "scope", "pull", "ask", "refused", "stopped", "canWrite" ], "type": "object" }, "CaissonLspAnswer": { "description": "A language server's answer, or how far it is from one.", "properties": { "diagnostics": { "items": { "$ref": "#/components/schemas/CaissonLspPlace" }, "type": [ "array", "null" ] }, "hover": { "type": [ "string", "null" ] }, "language": { "description": "`rust`, `typescript`, `python` or `go`.", "type": "string" }, "locations": { "items": { "$ref": "#/components/schemas/CaissonLspPlace" }, "type": [ "array", "null" ] }, "progress": { "default": [], "items": { "$ref": "#/components/schemas/CaissonLspProgress" }, "type": "array" }, "sandbox": { "description": "The sandbox the server runs in.", "type": "string" }, "state": { "description": "`installing`, `indexing` or `ready`; only `ready` answers the question.", "type": "string" }, "truncated": { "description": "More results exist than `limit`.", "type": [ "boolean", "null" ] } }, "required": [ "language", "sandbox", "state", "progress", "locations", "hover", "diagnostics", "truncated" ], "type": "object" }, "CaissonLspPlace": { "description": "A place in a file, with the server's note about it.", "properties": { "code": true, "column": { "description": "From 1, in characters.", "format": "uint64", "minimum": 0, "type": [ "integer", "null" ] }, "external": { "description": "The place is outside the caisson, in a dependency or the standard library.", "type": [ "boolean", "null" ] }, "line": { "description": "From 1.", "format": "uint64", "minimum": 0, "type": "integer" }, "message": { "description": "What a diagnostic says.", "type": [ "string", "null" ] }, "path": { "type": "string" }, "severity": { "type": [ "string", "null" ] }, "text": { "description": "The line of code at a location.", "type": [ "string", "null" ] } }, "required": [ "path", "line", "column", "text", "external", "severity", "code", "message" ], "type": "object" }, "CaissonLspProgress": { "description": "A step of the language server's start-up.", "properties": { "message": { "type": [ "string", "null" ] }, "percentage": { "format": "uint64", "minimum": 0, "type": [ "integer", "null" ] }, "title": { "type": "string" } }, "required": [ "title", "percentage", "message" ], "type": "object" }, "CaissonLspQuestion": { "description": "What a language server is asked.", "oneOf": [ { "const": "status", "description": "Whether the server is ready.", "type": "string" }, { "const": "definition", "description": "Where the symbol at a position is defined.", "type": "string" }, { "const": "references", "description": "Every use of the symbol at a position.", "type": "string" }, { "const": "hover", "description": "The type and documentation at a position.", "type": "string" }, { "const": "diagnostics", "description": "The compiler's errors and warnings for a file or the whole project.", "type": "string" } ] }, "CaissonLspRenamed": { "anyOf": [ { "$ref": "#/components/schemas/CaissonBatchResult" }, { "$ref": "#/components/schemas/CaissonLspAnswer" } ], "description": "What a rename answers: the changes, or the language server's state while it is not ready." }, "CaissonLspStopped": { "description": "The language server sandboxes that were stopped.", "properties": { "stopped": { "description": "The ids of the sandboxes.", "items": { "type": "string" }, "type": "array" } }, "required": [ "stopped" ], "type": "object" }, "CaissonPage": { "description": "A page of caissons, newest first.", "properties": { "items": { "items": { "$ref": "#/components/schemas/CaissonRow" }, "type": "array" }, "nextCursor": { "description": "Pass it as `cursor` for the next page; null on the last.", "type": [ "string", "null" ] } }, "required": [ "items", "nextCursor" ], "type": "object" }, "CaissonPolicy": { "properties": { "idleMinutes": { "format": "uint64", "minimum": 0, "type": "integer" }, "maxLive": { "format": "uint64", "minimum": 0, "type": "integer" }, "paths": { "items": { "$ref": "#/components/schemas/PathRule" }, "type": "array" }, "requireReview": { "default": "off", "description": "`off`, `agent` or `independent`.", "type": "string" } }, "required": [ "paths", "maxLive", "idleMinutes", "requireReview" ], "type": "object" }, "CaissonPull": { "properties": { "number": { "format": "uint64", "minimum": 0, "type": "integer" }, "repo": { "type": "string" } }, "required": [ "repo", "number" ], "type": "object" }, "CaissonRefused": { "properties": { "at": { "type": "string" }, "by": { "type": "string" }, "note": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "by", "note", "at" ], "type": "object" }, "CaissonReview": { "description": "One review of a caisson's code.", "properties": { "agent": { "type": "boolean" }, "at": { "type": "string" }, "findings": { "items": { "$ref": "#/components/schemas/ReviewFinding" }, "type": "array" }, "head": { "description": "The git tree that was reviewed.", "type": "string" }, "headSha": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "postError": { "type": [ "string", "null" ] }, "posted": { "description": "The pull request comment the review was posted as.", "format": "int64", "type": [ "integer", "null" ] }, "reviewer": { "type": "string" }, "selfReview": { "type": "boolean" }, "summary": { "type": "string" }, "verdict": { "description": "`approve` or `changes`.", "type": "string" }, "via": { "type": [ "string", "null" ] } }, "required": [ "id", "head", "headSha", "reviewer", "agent", "selfReview", "verdict", "summary", "findings", "at" ], "type": "object" }, "CaissonReviewStatus": { "description": "Where a caisson stands against the review its repository asks for.", "properties": { "blocked": { "description": "Why the caisson cannot ship yet; null when nothing blocks it.", "type": [ "string", "null" ] }, "head": { "description": "The git tree of the code as it is now.", "type": "string" }, "level": { "description": "`off`, `agent` or `independent`.", "type": "string" }, "reviews": { "items": { "$ref": "#/components/schemas/CaissonReview" }, "type": "array" } }, "required": [ "level", "head", "reviews", "blocked" ], "type": "object" }, "CaissonRow": { "description": "A caisson as a list shows it. With `brief` the row also names the files it changes and what it read.", "properties": { "ask": { "anyOf": [ { "$ref": "#/components/schemas/CaissonAsk" }, { "type": "null" } ], "description": "The write a person has to approve before the caisson goes on." }, "base": { "$ref": "#/components/schemas/CaissonBase" }, "branch": { "type": "string" }, "canWrite": { "description": "Whether the reader may write, stop it and answer its asks: false for guests and people without push access.", "type": "boolean" }, "changes": { "description": "With `brief`: the files the caisson changes.", "items": { "$ref": "#/components/schemas/CaissonChange" }, "type": [ "array", "null" ] }, "forkedFrom": { "description": "The caisson this one was forked from.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "openedAt": { "type": "string" }, "openedBy": { "$ref": "#/components/schemas/Opener" }, "pull": { "anyOf": [ { "$ref": "#/components/schemas/CaissonPull" }, { "type": "null" } ] }, "reads": { "description": "With `brief`: the paths a live caisson has read or searched.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "refused": { "anyOf": [ { "$ref": "#/components/schemas/CaissonRefused" }, { "type": "null" } ], "description": "The latest answer to a held write when it was a refusal and nothing has been written since." }, "repo": { "description": "The repository's name.", "type": "string" }, "scope": { "items": { "type": "string" }, "type": "array" }, "state": { "description": "`live`, `merged`, `stopped` or `closed`.", "type": "string" }, "stopped": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "repo", "openedBy", "title", "branch", "base", "state", "openedAt", "updatedAt", "scope", "pull", "ask", "refused", "stopped", "canWrite" ], "type": "object" }, "CaissonShipped": { "description": "What a ship did: the commit it made (null when nothing was pending), and the pull request it opened or found\nalready open.", "properties": { "commit": { "type": [ "string", "null" ] }, "pull": { "$ref": "#/components/schemas/Pull" }, "repo": { "description": "The repository's name.", "type": "string" }, "reused": { "description": "The caisson already had an open pull request, which was reused.", "type": "boolean" } }, "required": [ "repo", "commit", "pull", "reused" ], "type": "object" }, "CaissonTested": { "description": "How a test run ended.", "properties": { "note": { "description": "Set when the sandbox could not be destroyed afterwards; it ends on its own when its time is up.", "type": [ "string", "null" ] }, "result": { "$ref": "#/components/schemas/SandboxExecResult" }, "sandbox": { "description": "The id of the throwaway sandbox the command ran in.", "type": "string" } }, "required": [ "sandbox", "result" ], "type": "object" }, "Check": { "description": "One CI job, or one check run an app or a person reported, on a pull request's head commit, from\n`GET pulls/{n}/checks`. A check run has `run` 0, an empty `job` and its reporter's name as `workflow`.", "properties": { "checkRun": { "anyOf": [ { "$ref": "#/components/schemas/CheckRunBrief" }, { "type": "null" } ] }, "failedSteps": { "items": { "$ref": "#/components/schemas/CheckStep" }, "type": "array" }, "finishedAt": { "type": [ "string", "null" ] }, "job": { "type": "string" }, "name": { "type": "string" }, "run": { "format": "uint64", "minimum": 0, "type": "integer" }, "seconds": { "format": "double", "type": [ "number", "null" ] }, "source": { "$ref": "#/components/schemas/CheckSource", "default": "ci", "description": "Absent from servers before check runs, which sent CI jobs alone." }, "startedAt": { "type": "string" }, "state": { "$ref": "#/components/schemas/CheckState" }, "workflow": { "type": "string" } }, "required": [ "run", "workflow", "job", "name", "state", "startedAt", "finishedAt", "seconds", "failedSteps", "source" ], "type": "object" }, "CheckRun": { "description": "A check run as every route shows it.", "properties": { "actions": { "items": true, "type": "array" }, "annotations": { "items": true, "type": "array" }, "app": { "anyOf": [ { "$ref": "#/components/schemas/CheckRunApp2" }, { "type": "null" } ], "description": "The app that reports it; null for a person's run." }, "completedAt": { "format": "date-time", "type": [ "string", "null" ] }, "conclusion": { "description": "Set once completed: `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out` or `action_required`.", "type": [ "string", "null" ] }, "createdAt": { "format": "date-time", "type": "string" }, "detailsUrl": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "headSha": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "output": { "$ref": "#/components/schemas/CheckRunText" }, "owner": { "description": "The handle that reports it: the app's bot, or the person.", "type": "string" }, "startedAt": { "format": "date-time", "type": [ "string", "null" ] }, "state": { "description": "The run in the words of a CI job's state: pass, fail, pending, skipped or cancelled.", "type": "string" }, "status": { "description": "`queued`, `in_progress` or `completed`.", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "headSha", "status", "conclusion", "state", "startedAt", "completedAt", "detailsUrl", "externalId", "output", "annotations", "actions", "app", "owner", "createdAt", "updatedAt" ], "type": "object" }, "CheckRunAction": { "description": "A button on a check run.", "properties": { "description": { "default": "", "type": "string" }, "identifier": { "type": "string" }, "label": { "type": "string" } }, "required": [ "label", "identifier" ], "type": "object" }, "CheckRunApp": { "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "CheckRunApp2": { "description": "The app that reports a check run.", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "CheckRunBody": { "description": "Text shown with a check run, and the annotations on files that come with it.", "properties": { "annotations": { "default": [], "description": "Annotations, appended with the top-level ones.", "items": { "$ref": "#/components/schemas/Annotation" }, "type": "array" }, "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] } }, "type": "object" }, "CheckRunBrief": { "description": "What a check run row of `GET pulls/{n}/checks` says beyond its state (the server sends the whole run).", "properties": { "app": { "anyOf": [ { "$ref": "#/components/schemas/CheckRunApp" }, { "type": "null" } ] }, "conclusion": { "type": [ "string", "null" ] }, "detailsUrl": { "type": [ "string", "null" ] }, "id": { "format": "uint64", "minimum": 0, "type": "integer" }, "output": { "$ref": "#/components/schemas/CheckRunOutput" }, "owner": { "type": "string" } }, "required": [ "id", "app", "owner", "conclusion", "detailsUrl", "output" ], "type": "object" }, "CheckRunList": { "description": "The check runs on a commit.", "properties": { "checkRuns": { "items": { "$ref": "#/components/schemas/CheckRun" }, "type": "array" }, "total": { "format": "uint64", "minimum": 0, "type": "integer" } }, "required": [ "total", "checkRuns" ], "type": "object" }, "CheckRunOutput": { "properties": { "summary": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] } }, "required": [ "title", "summary" ], "type": "object" }, "CheckRunText": { "description": "What a check run says.", "properties": { "summary": { "type": [ "string", "null" ] }, "text": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] } }, "required": [ "title", "summary", "text" ], "type": "object" }, "CheckSource": { "enum": [ "ci", "app" ], "type": "string" }, "CheckState": { "enum": [ "pass", "fail", "pending", "skipped", "cancelled" ], "type": "string" }, "CheckStep": { "properties": { "index": { "format": "uint64", "minimum": 0, "type": "integer" }, "name": { "type": "string" } }, "required": [ "index", "name" ], "type": "object" }, "ChecksState": { "oneOf": [ { "enum": [ "pass", "fail", "pending", "none" ], "type": "string" }, { "const": "cancelled", "description": "Nothing failed or is pending and at least one check was cancelled: not passed.", "type": "string" } ] }, "Claim": { "description": "The lease an agent holds on an issue; it lapses at `until` unless renewed.", "properties": { "agent": { "description": "The token's name.", "type": [ "string", "null" ] }, "at": { "type": "string" }, "by": { "description": "The handle of the account the agent's token belongs to.", "type": "string" }, "client": { "type": [ "string", "null" ] }, "lastUpdateAt": { "type": [ "string", "null" ] }, "session": { "type": [ "string", "null" ] }, "surface": { "anyOf": [ { "$ref": "#/components/schemas/Surface" }, { "type": "null" } ] }, "token": { "type": [ "string", "null" ] }, "until": { "type": [ "string", "null" ] } }, "required": [ "by", "agent", "at", "until" ], "type": "object" }, "CloneDefaults": { "description": "How `sailfork repo clone` clones a repository when the caller passes no options: the folders to check out and\nwhether to skip file contents until they are needed (a blobless partial clone). Set by repo admins.", "properties": { "blobless": { "default": false, "description": "A blobless partial clone: the history and trees now, a file's contents when checked out.", "type": "boolean" }, "sparse": { "default": [], "description": "Folders a clone checks out (git's cone sparse checkout); empty for the whole tree.", "items": { "type": "string" }, "type": "array" } }, "required": [ "sparse", "blobless" ], "type": "object" }, "CloneDefaultsEdit": { "description": "A repository's new clone defaults.", "properties": { "blobless": { "default": false, "description": "A blobless partial clone: the history and trees now, a file's contents when checked out.", "type": "boolean" }, "sparse": { "default": [], "description": "Folders a clone checks out (git's cone sparse checkout); empty for the whole tree.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "CloseReason": { "enum": [ "done", "wontDo", "duplicate" ], "type": "string" }, "CodeLine": { "properties": { "column": { "description": "Byte offset of `text` in the full line: non-zero when a long line was cut.", "format": "uint", "minimum": 0, "type": "integer" }, "number": { "format": "uint", "minimum": 0, "type": "integer" }, "ranges": { "items": { "items": { "format": "uint", "minimum": 0, "type": "integer" }, "maxItems": 2, "minItems": 2, "type": "array" }, "type": "array" }, "text": { "type": "string" } }, "required": [ "number", "column", "text", "ranges" ], "type": "object" }, "CodeSnippet": { "properties": { "lines": { "items": { "$ref": "#/components/schemas/CodeLine" }, "type": "array" } }, "required": [ "lines" ], "type": "object" }, "CommentKind": { "oneOf": [ { "enum": [ "comment" ], "type": "string" }, { "const": "update", "description": "A structured progress entry from whoever holds the lease.", "type": "string" } ] }, "CommentProof": { "description": "A command and its result attached to a comment.", "properties": { "command": { "type": "string" }, "commit": { "type": [ "string", "null" ] }, "exitCode": { "format": "int32", "type": [ "integer", "null" ] }, "output": { "type": "string" }, "source": { "$ref": "#/components/schemas/ProofSource" }, "verified": { "description": "Sailfork ran it itself.", "type": "boolean" } }, "required": [ "command", "source", "verified" ], "type": "object" }, "CommitLog": { "anyOf": [ { "description": "Without `envelope`: the commits alone. A path's history that stopped at the search's step limit names where\nit goes on in the `X-History-Cursor` header.", "items": { "$ref": "#/components/schemas/CommitRecord" }, "type": "array" }, { "$ref": "#/components/schemas/CommitPage", "description": "With `envelope`." } ], "description": "A repository's history, or a path's, newest first." }, "CommitPage": { "properties": { "commits": { "items": { "$ref": "#/components/schemas/CommitRecord" }, "type": "array" }, "cursor": { "description": "Set when a path's history stopped at the search's step limit: pass it as `cursor` for the commits after\nthese. `null` when the list is whole.", "type": [ "string", "null" ] } }, "required": [ "commits", "cursor" ], "type": "object" }, "CommitRecord": { "description": "A commit as the explorer API sends it: `Commit` plus the author's address.", "properties": { "added": { "default": 0, "format": "uint64", "minimum": 0, "type": "integer" }, "at": { "type": "string" }, "author": { "type": "string" }, "email": { "type": "string" }, "files": { "default": 0, "format": "uint64", "minimum": 0, "type": "integer" }, "path": { "description": "In a path's history, where the file was named in this commit.", "type": [ "string", "null" ] }, "removed": { "default": 0, "format": "uint64", "minimum": 0, "type": "integer" }, "sha": { "type": "string" }, "short": { "type": "string" }, "subject": { "type": "string" } }, "required": [