Wikis - Create

Service:

Wiki

API Version:

5.0

Membuat sumber daya wiki.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path		string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '5.0' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
mappedPath	string	Jalur folder di dalam repositori yang ditampilkan sebagai Wiki. Tidak diperlukan untuk jenis ProjectWiki.
name	string	Nama Wiki.
projectId	string	ID proyek tempat wiki akan dibuat.
repositoryId	string	ID repositori git yang mencadangkan wiki. Tidak diperlukan untuk jenis ProjectWiki.
type	WikiType	Jenis wiki.
version	GitVersionDescriptor	Versi wiki. Tidak diperlukan untuk jenis ProjectWiki.

Respons

Nama	Jenis	Deskripsi
201 Created	WikiV2	Wiki dibuat

Keamanan

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

Nama	Deskripsi
vso.wiki_write	Memberikan kemampuan untuk membaca, membuat, dan memperbarui wiki, halaman wiki, dan lampiran wiki.

Contoh

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

Definisi

Nama	Deskripsi
GitVersionDescriptor
GitVersionOptions	Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)
GitVersionType	Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan
WikiCreateParametersV2	Parameter pembuatan Wiki.
WikiType	Jenis wiki.
WikiV2	Mendefinisikan sumber daya wiki.

GitVersionDescriptor

Nama	Jenis	Deskripsi
version	string	Pengidentifikasi string versi (nama tag/cabang, SHA1 penerapan)
versionOptions	GitVersionOptions	Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)
versionType	GitVersionType	Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

GitVersionOptions

Opsi versi - Tentukan pengubah tambahan ke versi (misalnya Sebelumnya)

Nama	Jenis	Deskripsi
firstParent	string	Induk pertama penerapan (HEAD^)
none	string	Tidak ditentukan
previousChange	string	Terapkan item yang diubah sebelum versi saat ini

GitVersionType

Jenis versi (cabang, tag, atau penerapan). Menentukan bagaimana Id ditafsirkan

Nama	Jenis	Deskripsi
branch	string	Menginterpretasikan versi sebagai nama cabang
commit	string	Menginterpretasikan versi sebagai ID penerapan (SHA1)
tag	string	Menginterpretasikan versi sebagai nama tag

WikiCreateParametersV2

Parameter pembuatan Wiki.

Nama	Jenis	Deskripsi
mappedPath	string	Jalur folder di dalam repositori yang ditampilkan sebagai Wiki. Tidak diperlukan untuk jenis ProjectWiki.
name	string	Nama Wiki.
projectId	string	ID proyek tempat wiki akan dibuat.
repositoryId	string	ID repositori git yang mencadangkan wiki. Tidak diperlukan untuk jenis ProjectWiki.
type	WikiType	Jenis wiki.
version	GitVersionDescriptor	Versi wiki. Tidak diperlukan untuk jenis ProjectWiki.

WikiType

Jenis wiki.

Nama	Jenis	Deskripsi
codeWiki	string	Menunjukkan bahwa wiki diterbitkan dari repositori git
projectWiki	string	Menunjukkan bahwa wiki disediakan untuk proyek tim

WikiV2

Mendefinisikan sumber daya wiki.

Nama	Jenis	Deskripsi
id	string	ID wiki.
mappedPath	string	Jalur folder di dalam repositori yang ditampilkan sebagai Wiki. Tidak diperlukan untuk jenis ProjectWiki.
name	string	Nama Wiki.
projectId	string	ID proyek tempat wiki akan dibuat.
properties	object	Properti wiki.
remoteUrl	string	Url web jarak jauh ke wiki.
repositoryId	string	ID repositori git yang mencadangkan wiki. Tidak diperlukan untuk jenis ProjectWiki.
type	WikiType	Jenis wiki.
url	string	Url REST untuk wiki ini.
versions	GitVersionDescriptor[]	Versi wiki.