GitHub · JSON Structure

Github Gists Base Gist Structure

Base Gist

Type: object Properties: 20 Required: 16

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

base-gist is a JSON Structure definition published by GitHub, describing 20 properties, of which 16 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url forks_url commits_url id node_id git_pull_url git_push_url html_url files public created_at updated_at description comments user comments_url owner truncated forks history

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-gists-base-gist-structure.json",
  "name": "base-gist",
  "description": "Base Gist",
  "type": "object",
  "properties": {
    "url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "forks_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "commits_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "id": {
      "type": "string",
      "example": "12345678"
    },
    "node_id": {
      "type": "string",
      "example": "12345678"
    },
    "git_pull_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "git_push_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "html_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "files": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "filename": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "raw_url": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          }
        }
      }
    },
    "public": {
      "type": "boolean",
      "example": true
    },
    "created_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "example": "This is an example repository"
    },
    "comments": {
      "type": "int32",
      "example": 42
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "comments_url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "truncated": {
      "type": "boolean",
      "example": true
    },
    "forks": {
      "type": "array",
      "items": {}
    },
    "history": {
      "type": "array",
      "items": {}
    }
  },
  "required": [
    "id",
    "node_id",
    "url",
    "forks_url",
    "commits_url",
    "git_pull_url",
    "git_push_url",
    "html_url",
    "comments_url",
    "public",
    "description",
    "comments",
    "user",
    "files",
    "created_at",
    "updated_at"
  ]
}