Installation

Installation

APIs.ioEngineeringPlatform

Properties

Name Type Description
id integer The ID of the installation.
account object
repository_selection string Describe whether all repositories have been selected or there's a selection involved
access_tokens_url string
repositories_url string
html_url string
app_id integer
target_id integer The ID of the user or organization this token is being scoped to.
target_type string
permissions object
events array
created_at string
updated_at string
single_file_name string
has_multiple_single_files boolean
single_file_paths array
app_slug string
suspended_by object
suspended_at string
contact_email string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-installation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/installation",
  "title": "Installation",
  "description": "Installation",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the installation.",
      "type": "integer",
      "example": 1
    },
    "account": {
      "nullable": true,
      "anyOf": [
        {
          "$ref": "#/components/schemas/simple-user"
        },
        {
          "$ref": "#/components/schemas/enterprise"
        }
      ]
    },
    "repository_selection": {
      "description": "Describe whether all repositories have been selected or there's a selection involved",
      "type": "string",
      "enum": [
        "all",
        "selected"
      ]
    },
    "access_tokens_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/app/installations/1/access_tokens"
    },
    "repositories_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/installation/repositories"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/organizations/github/settings/installations/1"
    },
    "app_id": {
      "type": "integer",
      "example": 1
    },
    "target_id": {
      "description": "The ID of the user or organization this token is being scoped to.",
      "type": "integer"
    },
    "target_type": {
      "type": "string",
      "example": "Organization"
    },
    "permissions": {
      "$ref": "#/components/schemas/app-permissions"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "single_file_name": {
      "type": "string",
      "example": "config.yaml",
      "nullable": true
    },
    "has_multiple_single_files": {
      "type": "boolean",
      "example": true
    },
    "single_file_paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "config.yml",
        ".github/issue_TEMPLATE.md"
      ]
    },
    "app_slug": {
      "type": "string",
      "example": "github-actions"
    },
    "suspended_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "suspended_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "contact_email": {
      "type": "string",
      "example": "\"[email protected]\"",
      "nullable": true
    }
  },
  "required": [
    "id",
    "app_id",
    "app_slug",
    "target_id",
    "target_type",
    "single_file_name",
    "repository_selection",
    "access_tokens_url",
    "html_url",
    "repositories_url",
    "events",
    "account",
    "permissions",
    "created_at",
    "updated_at",
    "suspended_by",
    "suspended_at"
  ]
}