GitHubIntegrationRead

Fields

15 fields

api_base_url · required: string
auth_kind: string
created_at · required: string (date-time)
enabled · required: boolean
has_pat · required: boolean
id · required: string (uuid)
installation_id: integer or null
last_error: string or null
last_error_at: string (date-time) or null
last_posted_at: string (date-time) or null
pr_comment_mode: string
project_id · required: string (uuid)
repo_name · required: string
repo_owner · required: string
updated_at · required: string (date-time)

Raw schema (JSON)

{
  "properties": {
    "api_base_url": {
      "title": "Api Base Url",
      "type": "string"
    },
    "auth_kind": {
      "default": "pat",
      "title": "Auth Kind",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "enabled": {
      "title": "Enabled",
      "type": "boolean"
    },
    "has_pat": {
      "title": "Has Pat",
      "type": "boolean"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "installation_id": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Installation Id"
    },
    "last_error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Error"
    },
    "last_error_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Error At"
    },
    "last_posted_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Posted At"
    },
    "pr_comment_mode": {
      "default": "failures_only",
      "title": "Pr Comment Mode",
      "type": "string"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "repo_name": {
      "title": "Repo Name",
      "type": "string"
    },
    "repo_owner": {
      "title": "Repo Owner",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "title": "Updated At",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "enabled",
    "repo_owner",
    "repo_name",
    "api_base_url",
    "has_pat",
    "created_at",
    "updated_at"
  ],
  "title": "GitHubIntegrationRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

GET /api/v1/projects/{project_id}/github-integration — Get Github Integration
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