Release

The [release](https://docs.github.com/[email protected]/rest/releases/releases/#get-a-release) object.

APIs.ioEngineeringPlatform

Properties

Name Type Description
assets array
assets_url string
author object
body string
created_at string
discussion_url string
draft boolean Whether the release is a draft or published
html_url string
id integer
name string
node_id string
prerelease boolean Whether the release is identified as a prerelease or a full release.
published_at string
reactions object
tag_name string The name of the tag.
tarball_url string
target_commitish string Specifies the commitish value that determines where the Git tag is created from.
upload_url string
url string
zipball_url string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhooks-release-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhooks_release",
  "title": "Release",
  "description": "The [release](https://docs.github.com/[email protected]/rest/releases/releases/#get-a-release) object.",
  "type": "object",
  "properties": {
    "assets": {
      "type": "array",
      "items": {
        "title": "Release Asset",
        "description": "Data related to a release.",
        "type": "object",
        "properties": {
          "browser_download_url": {
            "type": "string",
            "format": "uri"
          },
          "content_type": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "download_count": {
            "type": "integer"
          },
          "id": {
            "type": "integer"
          },
          "label": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "description": "The file name of the asset.",
            "type": "string"
          },
          "node_id": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "state": {
            "description": "State of the release asset.",
            "type": "string",
            "enum": [
              "uploaded"
            ]
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "uploader": {
            "title": "User",
            "type": "object",
            "nullable": true,
            "properties": {
              "avatar_url": {
                "type": "string",
                "format": "uri"
              },
              "deleted": {
                "type": "boolean"
              },
              "email": {
                "type": "string",
                "nullable": true
              },
              "events_url": {
                "type": "string",
                "format": "uri-template"
              },
              "followers_url": {
                "type": "string",
                "format": "uri"
              },
              "following_url": {
                "type": "string",
                "format": "uri-template"
              },
              "gists_url": {
                "type": "string",
                "format": "uri-template"
              },
              "gravatar_id": {
                "type": "string"
              },
              "html_url": {
                "type": "string",
                "format": "uri"
              },
              "id": {
                "type": "integer"
              },
              "login": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "node_id": {
                "type": "string"
              },
              "organizations_url": {
                "type": "string",
                "format": "uri"
              },
              "received_events_url": {
                "type": "string",
                "format": "uri"
              },
              "repos_url": {
                "type": "string",
                "format": "uri"
              },
              "site_admin": {
                "type": "boolean"
              },
              "starred_url": {
                "type": "string",
                "format": "uri-template"
              },
              "subscriptions_url": {
                "type": "string",
                "format": "uri"
              },
              "type": {
                "type": "string",
                "enum": [
                  "Bot",
                  "User",
                  "Organization"
                ]
              },
              "url": {
                "type": "string",
                "format": "uri"
              }
            },
            "required": [
              "login",
              "id"
            ]
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        },
        "required": [
          "url",
          "browser_download_url",
          "id",
          "node_id",
          "name",
          "label",
          "state",
          "content_type",
          "size",
          "download_count",
          "created_at",
          "updated_at"
        ]
      }
    },
    "assets_url": {
      "type": "string",
      "format": "uri"
    },
    "author": {
      "title": "User",
      "type": "object",
      "nullable": true,
      "properties": {
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "deleted": {
          "type": "boolean"
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "events_url": {
          "type": "string",
          "format": "uri-template"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string",
          "format": "uri-template"
        },
        "gists_url": {
          "type": "string",
          "format": "uri-template"
        },
        "gravatar_id": {
          "type": "string"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "id": {
          "type": "integer"
        },
        "login": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "site_admin": {
          "type": "boolean"
        },
        "starred_url": {
          "type": "string",
          "format": "uri-template"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "type": {
          "type": "string",
          "enum": [
            "Bot",
            "User",
            "Organization"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "login",
        "id"
      ]
    },
    "body": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "discussion_url": {
      "type": "string",
      "format": "uri"
    },
    "draft": {
      "description": "Whether the release is a draft or published",
      "type": "boolean"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "node_id": {
      "type": "string"
    },
    "prerelease": {
      "description": "Whether the release is identified as a prerelease or a full release.",
      "type": "boolean"
    },
    "published_at": {
      "type": "string",
      "nullable": true,
      "format": "date-time"
    },
    "reactions": {
      "title": "Reactions",
      "type": "object",
      "properties": {
        "+1": {
          "type": "integer"
        },
        "-1": {
          "type": "integer"
        },
        "confused": {
          "type": "integer"
        },
        "eyes": {
          "type": "integer"
        },
        "heart": {
          "type": "integer"
        },
        "hooray": {
          "type": "integer"
        },
        "laugh": {
          "type": "integer"
        },
        "rocket": {
          "type": "integer"
        },
        "total_count": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "url",
        "total_count",
        "+1",
        "-1",
        "laugh",
        "confused",
        "heart",
        "hooray",
        "eyes",
        "rocket"
      ]
    },
    "tag_name": {
      "description": "The name of the tag.",
      "type": "string"
    },
    "tarball_url": {
      "type": "string",
      "nullable": true,
      "format": "uri"
    },
    "target_commitish": {
      "description": "Specifies the commitish value that determines where the Git tag is created from.",
      "type": "string"
    },
    "upload_url": {
      "type": "string",
      "format": "uri-template"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "zipball_url": {
      "type": "string",
      "nullable": true,
      "format": "uri"
    }
  },
  "required": [
    "url",
    "assets_url",
    "upload_url",
    "html_url",
    "id",
    "node_id",
    "tag_name",
    "target_commitish",
    "name",
    "draft",
    "author",
    "prerelease",
    "created_at",
    "published_at",
    "assets",
    "tarball_url",
    "zipball_url",
    "body"
  ]
}