Atlassian · Schema

Ref

A ref object, representing a branch or tag in a repository.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
type string
links object
name string The name of the ref.
target object
View JSON Schema on GitHub

JSON Schema

atlassian-ref-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ref",
  "title": "Ref",
  "type": "object",
  "description": "A ref object, representing a branch or tag in a repository.",
  "properties": {
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "links": {
      "type": "object",
      "properties": {
        "self": {
          "type": "object",
          "title": "Link",
          "description": "A link to a resource related to this object.",
          "properties": {
            "href": {
              "type": "string",
              "format": "uri"
            },
            "name": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "commits": {
          "type": "object",
          "title": "Link",
          "description": "A link to a resource related to this object.",
          "properties": {
            "href": {
              "type": "string",
              "format": "uri"
            },
            "name": {
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "html": {
          "type": "object",
          "title": "Link",
          "description": "A link to a resource related to this object.",
          "properties": {
            "href": {
              "type": "string",
              "format": "uri"
            },
            "name": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false,
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "The name of the ref.",
      "example": "Example Title"
    },
    "target": {
      "$ref": "#/components/schemas/commit"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": true
}