Scoped Installation

APIs.ioEngineeringPlatform

Properties

Name Type Description
permissions object
repository_selection string Describe whether all repositories have been selected or there's a selection involved
single_file_name string
has_multiple_single_files boolean
single_file_paths array
repositories_url string
account object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-nullable-scoped-installation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/nullable-scoped-installation",
  "title": "Scoped Installation",
  "type": "object",
  "properties": {
    "permissions": {
      "$ref": "#/components/schemas/app-permissions"
    },
    "repository_selection": {
      "description": "Describe whether all repositories have been selected or there's a selection involved",
      "type": "string",
      "enum": [
        "all",
        "selected"
      ]
    },
    "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"
      ]
    },
    "repositories_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/repos"
    },
    "account": {
      "$ref": "#/components/schemas/simple-user"
    }
  },
  "required": [
    "permissions",
    "repository_selection",
    "single_file_name",
    "repositories_url",
    "account"
  ],
  "nullable": true
}