Azure DevOps · Schema

GitRef

A Git ref (branch or tag)

AgileCI/CDDevOpsProject ManagementVersion Control

Properties

Name	Type	Description
name	string	Full ref name (e.g., refs/heads/main)
objectId	string	The commit SHA this ref points to
creator	object
url	string
statuses	array	Commit status checks for this ref

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GitRef",
  "title": "GitRef",
  "type": "object",
  "description": "A Git ref (branch or tag)",
  "properties": {
    "name": {
      "type": "string",
      "description": "Full ref name (e.g., refs/heads/main)",
      "example": "refs/heads/main"
    },
    "objectId": {
      "type": "string",
      "description": "The commit SHA this ref points to",
      "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
    },
    "creator": {
      "$ref": "#/components/schemas/IdentityRef"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "statuses": {
      "type": "array",
      "description": "Commit status checks for this ref",
      "items": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string",
            "enum": [
              "error",
              "failed",
              "notApplicable",
              "notSet",
              "pending",
              "succeeded"
            ]
          },
          "description": {
            "type": "string"
          },
          "context": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "genre": {
                "type": "string"
              }
            }
          },
          "targetUrl": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  }
}