Milestone

A collection of related issues and pull requests.

APIs.ioEngineeringPlatform

Properties

Name Type Description
url string
html_url string
labels_url string
id integer
node_id string
number integer The number of the milestone.
state string The state of the milestone.
title string The title of the milestone.
description string
creator object
open_issues integer
closed_issues integer
created_at string
updated_at string
closed_at string
due_on string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-milestone-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/milestone",
  "title": "Milestone",
  "description": "A collection of related issues and pull requests.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/milestones/v1.0"
    },
    "labels_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"
    },
    "id": {
      "type": "integer",
      "example": 1002604
    },
    "node_id": {
      "type": "string",
      "example": "MDk6TWlsZXN0b25lMTAwMjYwNA=="
    },
    "number": {
      "description": "The number of the milestone.",
      "type": "integer",
      "example": 42
    },
    "state": {
      "description": "The state of the milestone.",
      "example": "open",
      "type": "string",
      "enum": [
        "open",
        "closed"
      ],
      "default": "open"
    },
    "title": {
      "description": "The title of the milestone.",
      "example": "v1.0",
      "type": "string"
    },
    "description": {
      "type": "string",
      "example": "Tracking milestone for version 1.0",
      "nullable": true
    },
    "creator": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "open_issues": {
      "type": "integer",
      "example": 4
    },
    "closed_issues": {
      "type": "integer",
      "example": 8
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-04-10T20:09:31Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2014-03-03T18:58:10Z"
    },
    "closed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2013-02-12T13:22:01Z",
      "nullable": true
    },
    "due_on": {
      "type": "string",
      "format": "date-time",
      "example": "2012-10-09T23:39:01Z",
      "nullable": true
    }
  },
  "required": [
    "closed_issues",
    "creator",
    "description",
    "due_on",
    "closed_at",
    "id",
    "node_id",
    "labels_url",
    "html_url",
    "number",
    "open_issues",
    "state",
    "title",
    "url",
    "created_at",
    "updated_at"
  ]
}