Wikis - Update

Servizio:

Wiki

Versione API:

7.1

Aggiorna il wiki corrispondente all'ID wiki o al nome wiki fornito usando i parametri di aggiornamento.

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?api-version=7.1

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
wikiIdentifier	path	True	string	ID wiki o nome wiki.
project	path		string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
name	string	Nome del wiki.
versions	GitVersionDescriptor[]	Versioni del wiki.

Risposte

Nome	Tipo	Descrizione
200 OK	WikiV2	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Ambiti

Nome	Descrizione
vso.wiki_write	Concede la possibilità di leggere, creare e aggiornare wiki, pagine wiki e allegati wiki.

Esempio

Update wiki versions

Esempio di richiesta

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/wiki/wikis/{wikiIdentifier}?api-version=7.1

{
  "versions": [
    {
      "version": "master"
    },
    {
      "version": "master"
    },
    {
      "version": "secondBranch"
    }
  ],
  "name": "newName"
}

Risposta di esempio

Codice di stato:

200

{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    },
    {
      "version": "secondBranch"
    }
  ],
  "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"
}

Definizioni

Nome	Descrizione
GitVersionDescriptor
GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID
WikiType	Tipo di wiki.
WikiUpdateParameters	Parametri di aggiornamento wiki.
WikiV2	Definisce una risorsa wiki.

GitVersionDescriptor

Object

Nome	Tipo	Descrizione
version	string	Identificatore della stringa di versione (nome di tag/ramo, SHA1 di commit)
versionOptions	GitVersionOptions	Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)
versionType	GitVersionType	Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

GitVersionOptions

Enumerazione

Opzioni di versione: specificare modificatori aggiuntivi per la versione (ad esempio Precedente)

Valore	Descrizione
firstParent	Primo elemento padre del commit (HEAD^)
none	Non specificato
previousChange	Eseguire il commit dell'elemento modificato prima della versione corrente

GitVersionType

Enumerazione

Tipo di versione (ramo, tag o commit). Determina la modalità di interpretazione dell'ID

Valore	Descrizione
branch	Interpretare la versione come nome di ramo
commit	Interpretare la versione come ID commit (SHA1)
tag	Interpretare la versione come nome di tag

WikiType

Enumerazione

Tipo di wiki.

Valore	Descrizione
codeWiki	Indica che il wiki viene pubblicato da un repository Git
projectWiki	Indica che viene effettuato il provisioning del wiki per il progetto team

WikiUpdateParameters

Object

Parametri di aggiornamento wiki.

Nome	Tipo	Descrizione
name	string	Nome del wiki.
versions	GitVersionDescriptor[]	Versioni del wiki.

WikiV2

Object

Definisce una risorsa wiki.

Nome	Tipo	Descrizione
id	string (uuid)	ID del wiki.
isDisabled	boolean	Repository wiki disabilitato
mappedPath	string	Percorso della cartella all'interno del repository visualizzato come Wiki. Non obbligatorio per il tipo ProjectWiki.
name	string	Nome wiki.
projectId	string (uuid)	ID del progetto in cui deve essere creato il wiki.
properties	object	Proprietà del wiki.
remoteUrl	string	URL Web remoto per il wiki.
repositoryId	string (uuid)	ID del repository Git che esegue il backup del wiki. Non obbligatorio per il tipo ProjectWiki.
type	WikiType	Tipo di wiki.
url	string	URL REST per questo wiki.
versions	GitVersionDescriptor[]	Versioni del wiki.