Wikis - Create

Служба:

Wiki

Версия API:

5.0

Создает вики-ресурс.

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis?api-version=5.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.

Текст запроса

Имя	Тип	Описание
mappedPath	string	Путь к папке внутри репозитория, который отображается как вики-сайт. Не требуется для типа ProjectWiki.
name	string	Имя вики-сайта.
projectId	string	Идентификатор проекта, в котором создается вики-сайт.
repositoryId	string	Идентификатор репозитория Git, создающего резервную копию вики-сайта. Не требуется для типа ProjectWiki.
type	WikiType	Тип вики-сайта.
version	GitVersionDescriptor	Версия вики-сайта. Не требуется для типа ProjectWiki.

Ответы

Имя	Тип	Описание
201 Created	WikiV2	Вики-сайт создан

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL-адрес токена: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Области

Имя	Описание
vso.wiki_write	Предоставляет возможность читать, создавать и обновлять вики-сайты, вики-страницы и вики-вложения.

Примеры

Create code wiki

Create project wiki

Create code wiki

Образец запроса

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Пример ответа

Код состояния:

201

{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Create project wiki

Образец запроса

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}

Пример ответа

Код состояния:

201

{
  "id": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_apis/wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "remoteUrl": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe",
  "repositoryId": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "mappedPath": "/"
}

Определения

Имя	Описание
GitVersionDescriptor
GitVersionOptions	Параметры версии — укажите дополнительные модификаторы для версии (например, Назад).
GitVersionType	Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор.
WikiCreateParametersV2	Параметры создания вики-сайта.
WikiType	Тип вики-сайта.
WikiV2	Определяет вики-ресурс.

GitVersionDescriptor

Объект

Имя	Тип	Описание
version	string	Идентификатор строки версии (имя тега или ветви, SHA1 фиксации)
versionOptions	GitVersionOptions	Параметры версии — укажите дополнительные модификаторы для версии (например, Назад).
versionType	GitVersionType	Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор.

GitVersionOptions

Перечисление

Параметры версии — укажите дополнительные модификаторы для версии (например, Назад).

Значение	Описание
none	Не указано
previousChange	Фиксация измененного элемента до текущей версии
firstParent	Первый родительский элемент фиксации (HEAD^)

GitVersionType

Перечисление

Тип версии (ветвь, тег или фиксация). Определяет, как интерпретируется идентификатор.

Значение	Описание
branch	Интерпретировать версию как имя ветви
tag	Интерпретация версии как имени тега
commit	Интерпретация версии как ИД фиксации (SHA1)

WikiCreateParametersV2

Объект

Параметры создания вики-сайта.

Имя	Тип	Описание
mappedPath	string	Путь к папке внутри репозитория, который отображается как вики-сайт. Не требуется для типа ProjectWiki.
name	string	Имя вики-сайта.
projectId	string	Идентификатор проекта, в котором создается вики-сайт.
repositoryId	string	Идентификатор репозитория Git, создающего резервную копию вики-сайта. Не требуется для типа ProjectWiki.
type	WikiType	Тип вики-сайта.
version	GitVersionDescriptor	Версия вики-сайта. Не требуется для типа ProjectWiki.

WikiType

Перечисление

Тип вики-сайта.

Значение	Описание
projectWiki	Указывает, что вики-сайт подготовлен для командного проекта.
codeWiki	Указывает, что вики-сайт опубликован из репозитория Git.

WikiV2

Объект

Определяет вики-ресурс.

Имя	Тип	Описание
id	string	Идентификатор вики-сайта.
mappedPath	string	Путь к папке внутри репозитория, который отображается как вики-сайт. Не требуется для типа ProjectWiki.
name	string	Имя вики-сайта.
projectId	string	Идентификатор проекта, в котором создается вики-сайт.
properties	object	Свойства вики-сайта.
remoteUrl	string	URL-адрес удаленного веб-сайта для вики-сайта.
repositoryId	string	Идентификатор репозитория Git, создающего резервную копию вики-сайта. Не требуется для типа ProjectWiki.
type	WikiType	Тип вики-сайта.
url	string	URL-адрес REST для этого вики-сайта.
versions	GitVersionDescriptor[]	Версии вики-сайта.