Wikis - Create

Hizmet:

Wiki

API Sürümü:

7.1

Wiki kaynağını oluşturur.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
mappedPath	string	Wiki olarak gösterilen deponun içindeki klasör yolu. ProjectWiki türü için gerekli değildir.
name	string	Wiki adı.
projectId	string (uuid)	Wiki'nin oluşturulacağı projenin kimliği.
repositoryId	string (uuid)	Wiki'yi yedekleyen git deposunun kimliği. ProjectWiki türü için gerekli değildir.
type	WikiType	Wiki'nin türü.
version	GitVersionDescriptor	Wiki sürümü. ProjectWiki türü için gerekli değildir.

Yanıtlar

Name	Tür	Description
201 Created	WikiV2	Wiki oluşturuldu

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Name	Description
vso.wiki_write	Wiki'leri, wiki sayfalarını ve wiki eklerini okuma, oluşturma ve güncelleştirme olanağı sağlar.

Örnekler

Create code wiki

Create project wiki

Create code wiki

Örnek isteği

HTTP

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

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Örnek yanıt

Durum kodu:

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

Örnek isteği

HTTP

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

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

Örnek yanıt

Durum kodu:

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

Tanımlar

Name	Description
GitVersionDescriptor
GitVersionOptions	Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örn. Önceki)
GitVersionType	Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler
WikiCreateParametersV2	Wiki oluşturma parametreleri.
WikiType	Wiki'nin türü.
WikiV2	Wiki kaynağını tanımlar.

GitVersionDescriptor

Object

Name	Tür	Description
version	string	Sürüm dizesi tanımlayıcısı (etiket/dal adı, işlemenin SHA1'i)
versionOptions	GitVersionOptions	Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örn. Önceki)
versionType	GitVersionType	Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler

GitVersionOptions

Listeleme

Sürüm seçenekleri - Sürüm için ek değiştiriciler belirtin (örn. Önceki)

Değer	Description
firstParent	İşlemenin ilk üst öğesi (HEAD^)
none	Belirtilmemiş
previousChange	Değiştirilen öğeyi geçerli sürümden önce işleme

GitVersionType

Listeleme

Sürüm türü (dal, etiket veya işleme). Kimliğin nasıl yorumleneceğini belirler

Değer	Description
branch	Sürümü dal adı olarak yorumlama
commit	Sürümü işleme kimliği (SHA1) olarak yorumlama
tag	Sürümü etiket adı olarak yorumlama

WikiCreateParametersV2

Object

Wiki oluşturma parametreleri.

Name	Tür	Description
mappedPath	string	Wiki olarak gösterilen deponun içindeki klasör yolu. ProjectWiki türü için gerekli değildir.
name	string	Wiki adı.
projectId	string (uuid)	Wiki'nin oluşturulacağı projenin kimliği.
repositoryId	string (uuid)	Wiki'yi yedekleyen git deposunun kimliği. ProjectWiki türü için gerekli değildir.
type	WikiType	Wiki'nin türü.
version	GitVersionDescriptor	Wiki sürümü. ProjectWiki türü için gerekli değildir.

WikiType

Listeleme

Wiki'nin türü.

Değer	Description
codeWiki	Wiki'nin git deposundan yayımlandığını gösterir
projectWiki	Wiki'nin takım projesi için sağlandığını gösterir

WikiV2

Object

Wiki kaynağını tanımlar.

Name	Tür	Description
id	string (uuid)	Wiki'nin kimliği.
isDisabled	boolean	Wiki deposu devre dışı mı
mappedPath	string	Wiki olarak gösterilen deponun içindeki klasör yolu. ProjectWiki türü için gerekli değildir.
name	string	Wiki adı.
projectId	string (uuid)	Wiki'nin oluşturulacağı projenin kimliği.
properties	object	Wiki'nin özellikleri.
remoteUrl	string	Wiki'nin uzak web url'si.
repositoryId	string (uuid)	Wiki'yi yedekleyen git deposunun kimliği. ProjectWiki türü için gerekli değildir.
type	WikiType	Wiki'nin türü.
url	string	Bu wiki için REST URL'si.
versions	GitVersionDescriptor[]	Wiki'nin sürümleri.