Git Commit

Low-level Git commit operations within a repository

APIs.ioEngineeringPlatform

Properties

Name Type Description
sha string SHA for the commit
node_id string
url string
author object Identifying information for the git-user
committer object Identifying information for the git-user
message string Message describing the purpose of the commit
tree object
parents array
verification object
html_url string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-git-commit-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/git-commit",
  "title": "Git Commit",
  "description": "Low-level Git commit operations within a repository",
  "type": "object",
  "properties": {
    "sha": {
      "description": "SHA for the commit",
      "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "author": {
      "description": "Identifying information for the git-user",
      "type": "object",
      "properties": {
        "date": {
          "description": "Timestamp of the commit",
          "example": "2014-08-09T08:02:04+12:00",
          "format": "date-time",
          "type": "string"
        },
        "email": {
          "type": "string",
          "description": "Git email address of the user",
          "example": "[email protected]"
        },
        "name": {
          "description": "Name of the git user",
          "example": "Monalisa Octocat",
          "type": "string"
        }
      },
      "required": [
        "email",
        "name",
        "date"
      ]
    },
    "committer": {
      "description": "Identifying information for the git-user",
      "type": "object",
      "properties": {
        "date": {
          "description": "Timestamp of the commit",
          "example": "2014-08-09T08:02:04+12:00",
          "format": "date-time",
          "type": "string"
        },
        "email": {
          "type": "string",
          "description": "Git email address of the user",
          "example": "[email protected]"
        },
        "name": {
          "description": "Name of the git user",
          "example": "Monalisa Octocat",
          "type": "string"
        }
      },
      "required": [
        "email",
        "name",
        "date"
      ]
    },
    "message": {
      "description": "Message describing the purpose of the commit",
      "example": "Fix #42",
      "type": "string"
    },
    "tree": {
      "type": "object",
      "properties": {
        "sha": {
          "description": "SHA for the commit",
          "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "sha",
        "url"
      ]
    },
    "parents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sha": {
            "description": "SHA for the commit",
            "example": "7638417db6d59f3c431d3e1f261cc637155684cd",
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "html_url": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "sha",
          "url",
          "html_url"
        ]
      }
    },
    "verification": {
      "type": "object",
      "properties": {
        "verified": {
          "type": "boolean"
        },
        "reason": {
          "type": "string"
        },
        "signature": {
          "type": "string",
          "nullable": true
        },
        "payload": {
          "type": "string",
          "nullable": true
        }
      },
      "required": [
        "verified",
        "reason",
        "signature",
        "payload"
      ]
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "required": [
    "sha",
    "node_id",
    "url",
    "html_url",
    "author",
    "committer",
    "tree",
    "message",
    "parents",
    "verification"
  ]
}