Wikis - Update

Dienst:

Wiki

API-Version:

7.1

Aktualisiert das Wiki, das der Wiki-ID oder dem Wiki-Namen entspricht, die mithilfe der Updateparameter bereitgestellt werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
wikiIdentifier	path	True	string	Wiki-ID oder Wiki-Name.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
name	string	Name für Wiki.
versions	GitVersionDescriptor[]	Versionen des Wikis.

Antworten

Name	Typ	Beschreibung
200 OK	WikiV2	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-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

Bereiche

Name	Beschreibung
vso.wiki_write	Gewährt die Möglichkeit, Wikis, Wiki-Seiten und Wiki-Anlagen zu lesen, zu erstellen und zu aktualisieren.

Beispiele

Update wiki versions

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
GitVersionDescriptor
GitVersionOptions	Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)
GitVersionType	Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird
WikiType	Typ des Wikis.
WikiUpdateParameters	Wiki-Updateparameter.
WikiV2	Definiert eine Wiki-Ressource.

GitVersionDescriptor

Objekt

Name	Typ	Beschreibung
version	string	Versionszeichenfolgenbezeichner (Name von Tag/Verzweigung, SHA1 des Commits)
versionOptions	GitVersionOptions	Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)
versionType	GitVersionType	Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird

GitVersionOptions

Enumeration

Versionsoptionen – Angeben zusätzlicher Modifizierer zu Version (z. B. Vorherige)

Wert	Beschreibung
firstParent	Erstes übergeordnetes Element des Commits (HEAD^)
none	Nicht angegeben
previousChange	Commit für dieses geänderte Element vor der aktuellen Version

GitVersionType

Enumeration

Versionstyp (Verzweigung, Tag oder Commit). Bestimmt, wie die ID interpretiert wird

Wert	Beschreibung
branch	Interpretieren der Version als Verzweigungsname
commit	Interpretieren der Version als Commit-ID (SHA1)
tag	Interpretieren der Version als Tagname

WikiType

Enumeration

Typ des Wikis.

Wert	Beschreibung
codeWiki	Gibt an, dass das Wiki aus einem Git-Repository veröffentlicht wird.
projectWiki	Gibt an, dass das Wiki für das Teamprojekt bereitgestellt wird.

WikiUpdateParameters

Objekt

Wiki-Updateparameter.

Name	Typ	Beschreibung
name	string	Name für Wiki.
versions	GitVersionDescriptor[]	Versionen des Wikis.

WikiV2

Objekt

Definiert eine Wiki-Ressource.

Name	Typ	Beschreibung
id	string (uuid)	ID des Wikis.
isDisabled	boolean	Ist das Wiki-Repository deaktiviert
mappedPath	string	Ordnerpfad innerhalb des Repositorys, das als Wiki angezeigt wird. Für ProjectWiki-Typ nicht erforderlich.
name	string	Wiki-Name.
projectId	string (uuid)	ID des Projekts, in dem das Wiki erstellt werden soll.
properties	object	Eigenschaften des Wikis.
remoteUrl	string	Remoteweb-URL zum Wiki.
repositoryId	string (uuid)	ID des Git-Repositorys, das das Wiki gesichert. Für ProjectWiki-Typ nicht erforderlich.
type	WikiType	Typ des Wikis.
url	string	REST-URL für dieses Wiki.
versions	GitVersionDescriptor[]	Versionen des Wikis.