Wikis - List

  • 参考
Service:
Wiki
API Version:
6.0

获取项目或集合中的所有 Wiki。

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

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
project
 path

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 应将其设置为“6.0”才能使用此版本的 API。

响应

名称 类型 说明
200 OK

WikiV2[]

成功的操作

安全性

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

名称 说明
vso.wiki 授予读取 Wiki、Wiki 页面和 Wiki 附件的能力。 此外，还授予搜索 Wiki 页面的能力。

示例

Query in collection
Query in project

Query in collection

Sample Request

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

Sample Response

Status code:
200 
transfer-Encoding: chunked
Response Body
{
  "value": [
    {
      "id": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "versions": [
        {
          "version": "wikiMaster"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "type": "projectWiki",
      "name": "sampleProjectWiki",
      "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
      "repositoryId": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "mappedPath": "/"
    },
    {
      "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"
    }
  ],
  "count": 2
}

Query in project

Sample Request

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

Sample Response

Status code:
200 
transfer-Encoding: chunked
Response Body
{
  "value": [
    {
      "id": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "versions": [
        {
          "version": "wikiMaster"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "type": "projectWiki",
      "name": "sampleProjectWiki",
      "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
      "repositoryId": "0ede3074-ce9f-4e0e-b9d6-20c23b774e05",
      "mappedPath": "/"
    },
    {
      "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"
    }
  ],
  "count": 2
}

定义

名称 说明
GitVersionDescriptor
GitVersionOptions

版本选项 - 指定版本 (的其他修饰符，例如上一)

GitVersionType

版本类型 (分支、标记或提交) 。 确定如何解释 ID
WikiType

Wiki 的类型。
WikiV2

定义 Wiki 资源。

GitVersionDescriptor

名称 类型 说明
version

string

版本字符串标识符 (标记/分支的名称，提交) 的 SHA1
versionOptions

GitVersionOptions

版本选项 - 指定版本 (的其他修饰符，例如上一)

versionType

GitVersionType

版本类型 (分支、标记或提交) 。 确定如何解释 ID

GitVersionOptions

版本选项 - 指定版本 (的其他修饰符，例如上一)

名称 类型 说明
firstParent

string

提交 (HEAD^) 的第一个父级
none

string

未指定
previousChange

string

在当前版本之前已更改项的提交

GitVersionType

版本类型 (分支、标记或提交) 。 确定如何解释 ID

名称 类型 说明
branch

string

将版本解释为分支名称
commit

string

将版本解释为提交 ID (SHA1)

tag

string

将版本解释为标记名称

WikiType

Wiki 的类型。

名称 类型 说明
codeWiki

string

指示 Wiki 是从 git 存储库发布的
projectWiki

string

指示为团队项目预配 Wiki

WikiV2

定义 Wiki 资源。

名称 类型 说明
id

string

Wiki 的 ID。
mappedPath

string

存储库中的文件夹路径，显示为 Wiki。 ProjectWiki 类型不需要。
name

string

Wiki 名称。
projectId

string

要在其中创建 Wiki 的项目的 ID。
properties

object

Wiki 的属性。
remoteUrl

string

Wiki 的远程 Web URL。
repositoryId

string

备份 Wiki 的 git 存储库的 ID。 ProjectWiki 类型不需要。
type

WikiType

Wiki 的类型。
url

string

此 Wiki 的 REST URL。
versions

GitVersionDescriptor[]

Wiki 的版本。