Wikis - Create

Service:

Wiki

API Version:

5.0

Tworzy zasób typu wiki.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "5.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
mappedPath	string	Ścieżka folderu wewnątrz repozytorium, które jest wyświetlane jako wiki. Typ ProjectWiki nie jest wymagany.
name	string	Nazwa witryny typu wiki.
projectId	string	Identyfikator projektu, w którym ma zostać utworzona witryna typu wiki.
repositoryId	string	Identyfikator repozytorium Git, które wykonuje kopię zapasową witryny typu wiki. Typ ProjectWiki nie jest wymagany.
type	WikiType	Typ strony typu wiki.
version	GitVersionDescriptor	Wersja witryny typu wiki. Typ ProjectWiki nie jest wymagany.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	WikiV2	Utworzono witrynę typu wiki

Zabezpieczenia

oauth2

Type: oauth2
Flow: accessCode
Authorization 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

Scopes

Nazwa	Opis
vso.wiki_write	Umożliwia odczytywanie, tworzenie i aktualizowanie stron typu wiki, stron typu wiki i załączników typu wiki.

Przykłady

Create code wiki

Create project wiki

Create code wiki

Sample Request

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

Sample Response

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

Sample Request

HTTP

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

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

Sample Response

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

Definicje

Nazwa	Opis
GitVersionDescriptor
GitVersionOptions	Opcje wersji — określ dodatkowe modyfikatory do wersji (np. poprzedniej)
GitVersionType	Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany
WikiCreateParametersV2	Parametry tworzenia witryny typu wiki.
WikiType	Typ strony typu wiki.
WikiV2	Definiuje zasób typu wiki.

GitVersionDescriptor

Nazwa	Typ	Opis
version	string	Identyfikator ciągu wersji (nazwa tagu/gałęzi, SHA1 zatwierdzenia)
versionOptions	GitVersionOptions	Opcje wersji — określ dodatkowe modyfikatory do wersji (np. poprzedniej)
versionType	GitVersionType	Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany

GitVersionOptions

Opcje wersji — określ dodatkowe modyfikatory do wersji (np. poprzedniej)

Nazwa	Typ	Opis
firstParent	string	Pierwszy element nadrzędny zatwierdzenia (HEAD^)
none	string	Nie określono
previousChange	string	Zatwierdzanie zmienionego elementu przed bieżącą wersją

GitVersionType

Typ wersji (gałąź, tag lub zatwierdzenie). Określa, jak identyfikator jest interpretowany

Nazwa	Typ	Opis
branch	string	Interpretowanie wersji jako nazwy gałęzi
commit	string	Interpretowanie wersji jako identyfikatora zatwierdzenia (SHA1)
tag	string	Interpretowanie wersji jako nazwy tagu

WikiCreateParametersV2

Parametry tworzenia witryny typu wiki.

Nazwa	Typ	Opis
mappedPath	string	Ścieżka folderu wewnątrz repozytorium, które jest wyświetlane jako wiki. Typ ProjectWiki nie jest wymagany.
name	string	Nazwa witryny typu wiki.
projectId	string	Identyfikator projektu, w którym ma zostać utworzona witryna typu wiki.
repositoryId	string	Identyfikator repozytorium Git, które wykonuje kopię zapasową witryny typu wiki. Typ ProjectWiki nie jest wymagany.
type	WikiType	Typ strony typu wiki.
version	GitVersionDescriptor	Wersja witryny typu wiki. Typ ProjectWiki nie jest wymagany.

WikiType

Typ strony typu wiki.

Nazwa	Typ	Opis
codeWiki	string	Wskazuje, że witryna typu wiki została opublikowana z repozytorium git
projectWiki	string	Wskazuje, że witryna typu wiki jest aprowizowana dla projektu zespołowego

WikiV2

Definiuje zasób typu wiki.

Nazwa	Typ	Opis
id	string	Identyfikator strony typu wiki.
mappedPath	string	Ścieżka folderu wewnątrz repozytorium, które jest wyświetlane jako wiki. Typ ProjectWiki nie jest wymagany.
name	string	Nazwa witryny typu wiki.
projectId	string	Identyfikator projektu, w którym ma zostać utworzona witryna typu wiki.
properties	object	Właściwości witryny typu wiki.
remoteUrl	string	Zdalny internetowy adres URL do witryny typu wiki.
repositoryId	string	Identyfikator repozytorium Git, które wykonuje kopię zapasową witryny typu wiki. Typ ProjectWiki nie jest wymagany.
type	WikiType	Typ strony typu wiki.
url	string	Adres URL REST dla tej witryny typu wiki.
versions	GitVersionDescriptor[]	Wersje witryny typu wiki.