Compartir a través de

Wikis - Create

  • Referencia
Servicio:
Wiki
Versión de la API:
5.0

Crea el recurso wiki.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

El nombre de la organización de Azure DevOps.
project
 path

string

Id. de proyecto o nombre del proyecto
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre Tipo Description
mappedPath

string

Ruta de acceso de carpeta dentro del repositorio que se muestra como Wiki. No es necesario para el tipo ProjectWiki.
name

string

Nombre de wiki.
projectId

string

Identificador del proyecto en el que se va a crear la wiki.
repositoryId

string

Identificador del repositorio git que realiza una copia de seguridad de la wiki. No es necesario para el tipo ProjectWiki.
type

WikiType

Tipo de wiki.
version

GitVersionDescriptor

Versión de la wiki. No es necesario para el tipo ProjectWiki.

Respuestas

Nombre Tipo Description
201 Created

WikiV2

Wiki creado

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

Nombre Description
vso.wiki_write Concede la capacidad de leer, crear y actualizar wikis, páginas wiki y datos adjuntos wiki.

Ejemplos

Create code wiki
Create project wiki

Create code wiki

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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": "/"
}

Definiciones

Nombre Description
GitVersionDescriptor
GitVersionOptions

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)
GitVersionType

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.
WikiCreateParametersV2

Parámetros de creación de wiki.
WikiType

Tipo de wiki.
WikiV2

Define un recurso wiki.

GitVersionDescriptor

Object
Nombre Tipo Description
version

string

Identificador de cadena de versión (nombre de etiqueta/rama, SHA1 de confirmación)
versionOptions

GitVersionOptions

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)
versionType

GitVersionType

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

GitVersionOptions

Enumeration

Opciones de versión: especifique modificadores adicionales para la versión (por ejemplo, Anterior)

Valor Description
firstParent

Primer elemento primario de confirmación (HEAD^)
none

Sin especificar
previousChange

Confirmar que cambió el elemento antes de la versión actual

GitVersionType

Enumeration

Tipo de versión (rama, etiqueta o confirmación). Determina cómo se interpreta id.

Valor Description
branch

Interpretar la versión como un nombre de rama
commit

Interpretar la versión como un identificador de confirmación (SHA1)
tag

Interpretar la versión como un nombre de etiqueta

WikiCreateParametersV2

Object

Parámetros de creación de wiki.

Nombre Tipo Description
mappedPath

string

Ruta de acceso de carpeta dentro del repositorio que se muestra como Wiki. No es necesario para el tipo ProjectWiki.
name

string

Nombre de wiki.
projectId

string

Identificador del proyecto en el que se va a crear la wiki.
repositoryId

string

Identificador del repositorio git que realiza una copia de seguridad de la wiki. No es necesario para el tipo ProjectWiki.
type

WikiType

Tipo de wiki.
version

GitVersionDescriptor

Versión de la wiki. No es necesario para el tipo ProjectWiki.

WikiType

Enumeration

Tipo de wiki.

Valor Description
codeWiki

Indica que la wiki se publica desde un repositorio git.
projectWiki

Indica que la wiki se aprovisiona para el proyecto de equipo.

WikiV2

Object

Define un recurso wiki.

Nombre Tipo Description
id

string

Identificador de la wiki.
mappedPath

string

Ruta de acceso de carpeta dentro del repositorio que se muestra como Wiki. No es necesario para el tipo ProjectWiki.
name

string

Nombre de wiki.
projectId

string

Identificador del proyecto en el que se va a crear la wiki.
properties

object

Propiedades de la wiki.
remoteUrl

string

Dirección URL web remota a la wiki.
repositoryId

string

Identificador del repositorio git que realiza una copia de seguridad de la wiki. No es necesario para el tipo ProjectWiki.
type

WikiType

Tipo de wiki.
url

string

Dirección URL de REST para esta wiki.
versions

GitVersionDescriptor[]

Versiones de la wiki.