GitHub · JSON Structure

Github Feeds Feed Structure

Feed

Type: object Properties: 11 Required: 3

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

feed is a JSON Structure definition published by GitHub, describing 11 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

timeline_url user_url current_user_public_url current_user_url current_user_actor_url current_user_organization_url current_user_organization_urls security_advisories_url repository_discussions_url repository_discussions_category_url _links

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-feeds-feed-structure.json",
  "name": "feed",
  "description": "Feed",
  "type": "object",
  "properties": {
    "timeline_url": {
      "type": "string",
      "example": "https://github.com/timeline"
    },
    "user_url": {
      "type": "string",
      "example": "https://github.com/{user}"
    },
    "current_user_public_url": {
      "type": "string",
      "example": "https://github.com/octocat"
    },
    "current_user_url": {
      "type": "string",
      "example": "https://github.com/octocat.private?token=abc123"
    },
    "current_user_actor_url": {
      "type": "string",
      "example": "https://github.com/octocat.private.actor?token=abc123"
    },
    "current_user_organization_url": {
      "type": "string",
      "example": "https://github.com/octocat-org"
    },
    "current_user_organization_urls": {
      "type": "array",
      "example": [
        "https://github.com/organizations/github/octocat.private.atom?token=abc123"
      ],
      "items": {
        "type": "uri"
      }
    },
    "security_advisories_url": {
      "type": "string",
      "example": "https://github.com/security-advisories"
    },
    "repository_discussions_url": {
      "type": "string",
      "example": "https://github.com/{user}/{repo}/discussions",
      "description": "A feed of discussions for a given repository."
    },
    "repository_discussions_category_url": {
      "type": "string",
      "example": "https://github.com/{user}/{repo}/discussions/categories/{category}",
      "description": "A feed of discussions for a given repository and category."
    },
    "_links": {
      "type": "object",
      "properties": {
        "timeline": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "user": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "security_advisories": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "current_user": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "current_user_public": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "current_user_actor": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "current_user_organization": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "current_user_organizations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/link-with-type"
          }
        },
        "repository_discussions": {
          "$ref": "#/components/schemas/link-with-type"
        },
        "repository_discussions_category": {
          "$ref": "#/components/schemas/link-with-type"
        }
      },
      "required": [
        "timeline",
        "user"
      ]
    }
  },
  "required": [
    "_links",
    "timeline_url",
    "user_url"
  ]
}