GitHub · JSON Structure

Github Repo Autolinks Api Autolink Structure

An autolink reference.

Type: object Properties: 4 Required: 4
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

Properties

id key_prefix url_template is_alphanumeric

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-repo-autolinks-api-autolink-structure.json",
  "name": "autolink",
  "description": "An autolink reference.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "example": 3
    },
    "key_prefix": {
      "description": "The prefix of a key that is linkified.",
      "example": "TICKET-",
      "type": "string"
    },
    "url_template": {
      "description": "template for the target URL that is generated if a key was found.",
      "example": "https://example.com/TICKET?query=<num>",
      "type": "string"
    },
    "is_alphanumeric": {
      "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.",
      "example": true,
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "key_prefix",
    "url_template",
    "is_alphanumeric"
  ]
}