GitHubIntegrationWrite

Fields

7 fields

api_base_url

string

auth_kind

string or null

enabled

boolean

pat

string or null

pr_comment_mode

string

repo_name · required

string

repo_owner · required

string

Raw schema (JSON)

{
  "properties": {
    "api_base_url": {
      "default": "https://api.github.com",
      "maxLength": 500,
      "title": "Api Base Url",
      "type": "string"
    },
    "auth_kind": {
      "anyOf": [
        {
          "enum": [
            "pat",
            "app"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Auth Kind"
    },
    "enabled": {
      "default": true,
      "title": "Enabled",
      "type": "boolean"
    },
    "pat": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pat"
    },
    "pr_comment_mode": {
      "default": "failures_only",
      "enum": [
        "off",
        "failures_only",
        "always"
      ],
      "title": "Pr Comment Mode",
      "type": "string"
    },
    "repo_name": {
      "maxLength": 255,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9._-]+$",
      "title": "Repo Name",
      "type": "string"
    },
    "repo_owner": {
      "maxLength": 255,
      "minLength": 1,
      "pattern": "^[A-Za-z0-9._-]+$",
      "title": "Repo Owner",
      "type": "string"
    }
  },
  "required": [
    "repo_owner",
    "repo_name"
  ],
  "title": "GitHubIntegrationWrite",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• PUT /api/v1/projects/{project_id}/github-integration — Upsert Github Integration

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON