GitHub · Schema

autolink

An autolink reference.

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

Properties

Name Type Description
id integer
key_prefix string The prefix of a key that is linkified.
url_template string template for the target URL that is generated if a key was found.
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
View JSON Schema on GitHub

JSON Schema

github-repo-autolinks-api-autolink-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-repo-autolinks-api-autolink-schema.json",
  "title": "autolink",
  "description": "An autolink reference.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "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"
  ]
}