Azure DevOps · Schema

WikiV2

An Azure DevOps wiki

AgileCI/CDDevOpsProject ManagementVersion Control

Properties

Name Type Description
id string Unique GUID identifier of the wiki
name string Display name of the wiki
type string Type of wiki
projectId string ID of the project this wiki belongs to
repositoryId string ID of the backing Git repository
mappedPath string Root folder path in the repository (for code wikis)
versions array Branches or versions available for this wiki
url string URL to access this wiki via the REST API
remoteUrl string Clone URL for the backing repository
_links object
View JSON Schema on GitHub

JSON Schema

microsoft-azure-devops-wikiv2-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WikiV2",
  "title": "WikiV2",
  "type": "object",
  "description": "An Azure DevOps wiki",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique GUID identifier of the wiki"
    },
    "name": {
      "type": "string",
      "description": "Display name of the wiki",
      "example": "Project Wiki"
    },
    "type": {
      "type": "string",
      "description": "Type of wiki",
      "enum": [
        "projectWiki",
        "codeWiki"
      ]
    },
    "projectId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the project this wiki belongs to"
    },
    "repositoryId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the backing Git repository"
    },
    "mappedPath": {
      "type": "string",
      "description": "Root folder path in the repository (for code wikis)",
      "example": "/wiki"
    },
    "versions": {
      "type": "array",
      "description": "Branches or versions available for this wiki",
      "items": {
        "type": "object",
        "properties": {
          "version": {
            "type": "string",
            "description": "Branch name",
            "example": "main"
          }
        }
      }
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to access this wiki via the REST API"
    },
    "remoteUrl": {
      "type": "string",
      "format": "uri",
      "description": "Clone URL for the backing repository"
    },
    "_links": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  }
}