Discussion

A Discussion in a repository.

APIs.ioEngineeringPlatform

Properties

Name Type Description
active_lock_reason string
answer_chosen_at string
answer_chosen_by object
answer_html_url string
author_association string How the author is associated with the repository.
body string
category object
comments integer
created_at string
html_url string
id integer
locked boolean
node_id string
number integer
reactions object
repository_url string
state string The current state of the discussion. `converting` means that the discussion is being converted from an issue. `transferring` means that the discussion is being transferred from another repository.
state_reason string The reason for the current state
timeline_url string
title string
updated_at string
user object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-discussion-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/discussion",
  "title": "Discussion",
  "description": "A Discussion in a repository.",
  "type": "object",
  "properties": {
    "active_lock_reason": {
      "type": "string",
      "nullable": true
    },
    "answer_chosen_at": {
      "type": "string",
      "nullable": true
    },
    "answer_chosen_by": {
      "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"
      ]
    },
    "answer_html_url": {
      "type": "string",
      "nullable": true
    },
    "author_association": {
      "title": "AuthorAssociation",
      "description": "How the author is associated with the repository.",
      "type": "string",
      "enum": [
        "COLLABORATOR",
        "CONTRIBUTOR",
        "FIRST_TIMER",
        "FIRST_TIME_CONTRIBUTOR",
        "MANNEQUIN",
        "MEMBER",
        "NONE",
        "OWNER"
      ]
    },
    "body": {
      "type": "string"
    },
    "category": {
      "type": "object",
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "description": {
          "type": "string"
        },
        "emoji": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "is_answerable": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        },
        "repository_id": {
          "type": "integer"
        },
        "slug": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "repository_id",
        "emoji",
        "name",
        "description",
        "created_at",
        "updated_at",
        "slug",
        "is_answerable"
      ]
    },
    "comments": {
      "type": "integer"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "html_url": {
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "locked": {
      "type": "boolean"
    },
    "node_id": {
      "type": "string"
    },
    "number": {
      "type": "integer"
    },
    "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"
      ]
    },
    "repository_url": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.",
      "enum": [
        "open",
        "closed",
        "locked",
        "converting",
        "transferring"
      ]
    },
    "state_reason": {
      "description": "The reason for the current state",
      "example": "resolved",
      "type": "string",
      "nullable": true,
      "enum": [
        "resolved",
        "outdated",
        "duplicate",
        "reopened"
      ]
    },
    "timeline_url": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "user": {
      "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",
          "format": "int64"
        },
        "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"
      ]
    }
  },
  "required": [
    "repository_url",
    "category",
    "answer_html_url",
    "answer_chosen_at",
    "answer_chosen_by",
    "html_url",
    "id",
    "node_id",
    "number",
    "title",
    "user",
    "state",
    "state_reason",
    "locked",
    "comments",
    "created_at",
    "updated_at",
    "author_association",
    "active_lock_reason",
    "body"
  ]
}