Partilhar via

Wikis - Create

  • Referência
Serviço:
Wiki
Versão da API:
5.0

Cria o recurso wiki.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '5.0' para usar esta versão da API.

Corpo da solicitação

Nome Tipo Description
mappedPath

string

Caminho da pasta dentro do repositório, que é mostrado como Wiki. Não é necessário para o tipo ProjectWiki.
name

string

Nome do wiki.
projectId

string

ID do projeto no qual o wiki deve ser criado.
repositoryId

string

ID do repositório git que faz backup do wiki. Não é necessário para o tipo ProjectWiki.
type

WikiType

Tipo de wiki.
version

GitVersionDescriptor

Versão do wiki. Não é necessário para o tipo ProjectWiki.

Respostas

Nome Tipo Description
201 Created

WikiV2

Wiki criado

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome Description
vso.wiki_write Concede a capacidade de ler, criar e atualizar wikis, páginas wiki e anexos wiki.

Exemplos

Create code wiki
Create project wiki

Create code wiki

Solicitação de exemplo

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"
}

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

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

Resposta de exemplo

Código de status:
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": "/"
}

Definições

Nome Description
GitVersionDescriptor
GitVersionOptions

Opções de versão – especifique modificadores adicionais para a versão (por exemplo, Anterior)
GitVersionType

Tipo de versão (branch, marca ou confirmação). Determina como a ID é interpretada
WikiCreateParametersV2

Parâmetros de criação de wiki.
WikiType

Tipo de wiki.
WikiV2

Define um recurso wiki.

GitVersionDescriptor

Object
Nome Tipo Description
version

string

Identificador de cadeia de caracteres de versão (nome da marca/branch, SHA1 do commit)
versionOptions

GitVersionOptions

Opções de versão – especifique modificadores adicionais para a versão (por exemplo, Anterior)
versionType

GitVersionType

Tipo de versão (branch, marca ou confirmação). Determina como a ID é interpretada

GitVersionOptions

Enumeration

Opções de versão – especifique modificadores adicionais para a versão (por exemplo, Anterior)

Valor Description
firstParent

Primeiro pai do commit (HEAD^)
none

Não especificado
previousChange

Confirmar o item alterado antes da versão atual

GitVersionType

Enumeration

Tipo de versão (branch, marca ou confirmação). Determina como a ID é interpretada

Valor Description
branch

Interpretar a versão como um nome de branch
commit

Interpretar a versão como um SHA1 (ID do commit)
tag

Interpretar a versão como um nome de marca

WikiCreateParametersV2

Object

Parâmetros de criação de wiki.

Nome Tipo Description
mappedPath

string

Caminho da pasta dentro do repositório, que é mostrado como Wiki. Não é necessário para o tipo ProjectWiki.
name

string

Nome do wiki.
projectId

string

ID do projeto no qual o wiki deve ser criado.
repositoryId

string

ID do repositório git que faz backup do wiki. Não é necessário para o tipo ProjectWiki.
type

WikiType

Tipo de wiki.
version

GitVersionDescriptor

Versão do wiki. Não é necessário para o tipo ProjectWiki.

WikiType

Enumeration

Tipo de wiki.

Valor Description
codeWiki

Indica que o wiki foi publicado de um repositório git
projectWiki

Indica que o wiki está provisionado para o projeto de equipe

WikiV2

Object

Define um recurso wiki.

Nome Tipo Description
id

string

ID do wiki.
mappedPath

string

Caminho da pasta dentro do repositório, que é mostrado como Wiki. Não é necessário para o tipo ProjectWiki.
name

string

Nome do wiki.
projectId

string

ID do projeto no qual o wiki deve ser criado.
properties

object

Propriedades do wiki.
remoteUrl

string

URL da Web remota para o wiki.
repositoryId

string

ID do repositório git que faz backup do wiki. Não é necessário para o tipo ProjectWiki.
type

WikiType

Tipo de wiki.
url

string

URL REST para este wiki.
versions

GitVersionDescriptor[]

Versões do wiki.