Wikis - Create
wiki 리소스를 만듭니다.
POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis?api-version=5.0
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 조직의 이름입니다. |
|
project
|
path |
string |
프로젝트 ID 또는 프로젝트 이름 |
|
|
api-version
|
query | True |
string |
사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '5.0'으로 설정해야 합니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| mappedPath |
string |
Wiki로 표시되는 리포지토리 내의 폴더 경로입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| name |
string |
Wiki 이름입니다. |
| projectId |
string |
wiki를 만들 프로젝트의 ID입니다. |
| repositoryId |
string |
wiki를 백업하는 git 리포지토리의 ID입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| type |
위키의 유형입니다. |
|
| version |
Wiki 버전입니다. ProjectWiki 형식에는 필요하지 않습니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 201 Created |
Wiki 생성됨 |
보안
oauth2
형식:
oauth2
Flow:
accessCode
권한 부여 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
토큰 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
범위
| Name | Description |
|---|---|
| vso.wiki_write | 위키, 위키 페이지 및 위키 첨부 파일을 읽고, 만들고, 업데이트할 수 있는 기능을 부여합니다. |
예제
| Create code wiki |
| Create project wiki |
Create code wiki
샘플 요청
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"
}
샘플 응답
{
"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
샘플 요청
POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0
{
"type": "projectWiki",
"name": "sampleProjectWiki",
"projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}
샘플 응답
{
"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": "/"
}
정의
| Name | Description |
|---|---|
|
Git |
|
|
Git |
버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전) |
|
Git |
버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다. |
|
Wiki |
Wiki 생성 매개 변수입니다. |
|
Wiki |
위키의 유형입니다. |
| WikiV2 |
wiki 리소스를 정의합니다. |
GitVersionDescriptor
| Name | 형식 | Description |
|---|---|---|
| version |
string |
버전 문자열 식별자(태그/분기 이름, 커밋의 SHA1) |
| versionOptions |
버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전) |
|
| versionType |
버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다. |
GitVersionOptions
버전 옵션 - 버전에 대한 추가 한정자 지정(예: 이전)
| 값 | Description |
|---|---|
| firstParent |
커밋의 첫 번째 부모(HEAD^) |
| none |
지정되지 않음 |
| previousChange |
현재 버전 이전에 변경된 항목을 커밋합니다. |
GitVersionType
버전 유형(분기, 태그 또는 커밋). ID가 해석되는 방법을 결정합니다.
| 값 | Description |
|---|---|
| branch |
버전을 분기 이름으로 해석 |
| commit |
버전을 SHA1(커밋 ID)으로 해석 |
| tag |
버전을 태그 이름으로 해석 |
WikiCreateParametersV2
Wiki 생성 매개 변수입니다.
| Name | 형식 | Description |
|---|---|---|
| mappedPath |
string |
Wiki로 표시되는 리포지토리 내의 폴더 경로입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| name |
string |
Wiki 이름입니다. |
| projectId |
string |
wiki를 만들 프로젝트의 ID입니다. |
| repositoryId |
string |
wiki를 백업하는 git 리포지토리의 ID입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| type |
위키의 유형입니다. |
|
| version |
Wiki 버전입니다. ProjectWiki 형식에는 필요하지 않습니다. |
WikiType
위키의 유형입니다.
| 값 | Description |
|---|---|
| codeWiki |
wiki가 git 리포지토리에서 게시되었음을 나타냅니다. |
| projectWiki |
Wiki가 팀 프로젝트에 대해 프로비전됨을 나타냅니다. |
WikiV2
wiki 리소스를 정의합니다.
| Name | 형식 | Description |
|---|---|---|
| id |
string |
wiki의 ID입니다. |
| mappedPath |
string |
Wiki로 표시되는 리포지토리 내의 폴더 경로입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| name |
string |
Wiki 이름입니다. |
| projectId |
string |
wiki를 만들 프로젝트의 ID입니다. |
| properties |
object |
wiki의 속성입니다. |
| remoteUrl |
string |
Wiki에 대한 원격 웹 URL입니다. |
| repositoryId |
string |
wiki를 백업하는 git 리포지토리의 ID입니다. ProjectWiki 형식에는 필요하지 않습니다. |
| type |
위키의 유형입니다. |
|
| url |
string |
이 wiki에 대한 REST URL입니다. |
| versions |
Wiki 버전입니다. |