Release

A release.

APIs.ioEngineeringPlatform

Properties

Name Type Description
url string
html_url string
assets_url string
upload_url string
tarball_url string
zipball_url string
id integer
node_id string
tag_name string The name of the tag.
target_commitish string Specifies the commitish value that determines where the Git tag is created from.
name string
body string
draft boolean true to create a draft (unpublished) release, false to create a published one.
prerelease boolean Whether to identify the release as a prerelease or a full release.
created_at string
published_at string
author object
assets array
body_html string
body_text string
mentions_count integer
reactions object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-release-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/release",
  "title": "Release",
  "description": "A release.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "assets_url": {
      "type": "string",
      "format": "uri"
    },
    "upload_url": {
      "type": "string"
    },
    "tarball_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "zipball_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "id": {
      "type": "integer"
    },
    "node_id": {
      "type": "string"
    },
    "tag_name": {
      "description": "The name of the tag.",
      "example": "v1.0.0",
      "type": "string"
    },
    "target_commitish": {
      "description": "Specifies the commitish value that determines where the Git tag is created from.",
      "example": "master",
      "type": "string"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "body": {
      "type": "string",
      "nullable": true
    },
    "draft": {
      "description": "true to create a draft (unpublished) release, false to create a published one.",
      "example": false,
      "type": "boolean"
    },
    "prerelease": {
      "description": "Whether to identify the release as a prerelease or a full release.",
      "example": false,
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "published_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "author": {
      "$ref": "#/components/schemas/simple-user"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/release-asset"
      }
    },
    "body_html": {
      "type": "string"
    },
    "body_text": {
      "type": "string"
    },
    "mentions_count": {
      "type": "integer"
    },
    "reactions": {
      "$ref": "#/components/schemas/reaction-rollup"
    }
  },
  "required": [
    "assets_url",
    "upload_url",
    "tarball_url",
    "zipball_url",
    "created_at",
    "published_at",
    "draft",
    "id",
    "node_id",
    "author",
    "html_url",
    "name",
    "prerelease",
    "tag_name",
    "target_commitish",
    "assets",
    "url"
  ]
}