GitHub · JSON Structure

Github Meta Api Overview Structure

Api Overview

Type: object Properties: 5 Required: 1
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

api-overview is a JSON Structure definition published by GitHub, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

verifiable_password_authentication packages dependabot domains installed_version

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-meta-api-overview-structure.json",
  "name": "api-overview",
  "description": "Api Overview",
  "type": "object",
  "properties": {
    "verifiable_password_authentication": {
      "type": "boolean",
      "example": true
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "dependabot": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "domains": {
      "type": "object",
      "properties": {
        "website": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "codespaces": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "copilot": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "packages": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "actions": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        }
      }
    },
    "installed_version": {
      "type": "string",
      "example": "3.9.0"
    }
  },
  "required": [
    "verifiable_password_authentication"
  ]
}