GitHub · JSON Structure

Github Gists Gist Simple Structure

Gist Simple

Type: object Properties: 21
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

gist-simple is a JSON Structure definition published by GitHub, describing 21 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

forks history fork_of 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

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-gists-gist-simple-structure.json",
  "name": "gist-simple",
  "description": "Gist Simple",
  "type": "object",
  "properties": {
    "forks": {
      "deprecated": true,
      "nullable": true,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "uri"
          },
          "user": {
            "$ref": "#/components/schemas/public-user"
          },
          "created_at": {
            "type": "datetime"
          },
          "updated_at": {
            "type": "datetime"
          }
        }
      }
    },
    "history": {
      "deprecated": true,
      "nullable": true,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/gist-history"
      }
    },
    "fork_of": {
      "nullable": true,
      "name": "Gist",
      "description": "Gist",
      "type": "object",
      "properties": {
        "url": {
          "type": "uri"
        },
        "forks_url": {
          "type": "uri"
        },
        "commits_url": {
          "type": "uri"
        },
        "id": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        },
        "git_pull_url": {
          "type": "uri"
        },
        "git_push_url": {
          "type": "uri"
        },
        "html_url": {
          "type": "uri"
        },
        "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"
        },
        "created_at": {
          "type": "datetime"
        },
        "updated_at": {
          "type": "datetime"
        },
        "description": {
          "type": "string",
          "nullable": true
        },
        "comments": {
          "type": "int32"
        },
        "user": {
          "$ref": "#/components/schemas/nullable-simple-user"
        },
        "comments_url": {
          "type": "uri"
        },
        "owner": {
          "$ref": "#/components/schemas/nullable-simple-user"
        },
        "truncated": {
          "type": "boolean"
        },
        "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"
      ]
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "forks_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "commits_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "id": {
      "type": "string",
      "example": "12345678"
    },
    "node_id": {
      "type": "string",
      "example": "12345678"
    },
    "git_pull_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "git_push_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "html_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "files": {
      "type": "object",
      "additionalProperties": {
        "nullable": true,
        "type": "object",
        "properties": {
          "filename": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "raw_url": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "truncated": {
            "type": "boolean"
          },
          "content": {
            "type": "string"
          }
        }
      }
    },
    "public": {
      "type": "boolean",
      "example": true
    },
    "created_at": {
      "type": "string",
      "example": "2026-04-17T12:00:00Z"
    },
    "updated_at": {
      "type": "string",
      "example": "2026-04-17T12:00:00Z"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "example": "This is an example repository"
    },
    "comments": {
      "type": "int32",
      "example": 42
    },
    "user": {
      "type": "string",
      "nullable": true,
      "example": "example_value"
    },
    "comments_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "truncated": {
      "type": "boolean"
    }
  }
}