Pages - Create Or Update

服务:

Wiki

API 版本:

7.1

创建或编辑 Wiki 页面。

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&api-version=7.1

具有可选参数:

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&comment={comment}&versionDescriptor.version={versionDescriptor.version}&versionDescriptor.versionOptions={versionDescriptor.versionOptions}&versionDescriptor.versionType={versionDescriptor.versionType}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
wikiIdentifier	path	True	string	Wiki ID 或 Wiki 名称。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
path	query	True	string	Wiki 页面路径。
comment	query		string	要与页面作关联的注释。
versionDescriptor.version	query		string	版本字符串标识符（标记/分支的名称，提交 SHA1）
versionDescriptor.versionOptions	query		GitVersionOptions	版本选项 - 指定版本的其他修饰符（例如上一个）
versionDescriptor.versionType	query		GitVersionType	版本类型（分支、标记或提交）。 确定如何解释 ID

请求头

名称	必需	类型	说明
Version	True	string	要对其进行更改的页面的版本。 Edit 方案是必需的。 在请求的 If-Match 标头中填充。

请求正文

名称	类型	说明
content	string	Wiki 页面的内容。

响应

名称	类型	说明
200 OK	WikiPage	页面已编辑。 编辑的页面版本在 ETag 响应标头中填充。 标头 ETag: string
201 Created	WikiPage	已创建页面。 在 ETag 响应标头中填充已创建页面的版本。 标头 ETag: string

安全性

oauth2

类型: oauth2
流向: 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

作用域

名称	说明
vso.wiki_write	授予读取、创建和更新 Wiki、Wiki 网页和 Wiki 附件的功能。

示例

Add a page

Edit a page

Add a page

示例请求

HTTP

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=SamplePage973&api-version=7.1

{
  "content": "Wiki page content"
}

示例响应

状态代码:

201

eTag: "4c6adda4736aae086c7ae1956da1d91aba09d6fb"

{
  "path": "/SamplePage973",
  "order": 1,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "Wiki page content"
}

Edit a page

示例请求

HTTP

PUT https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/SamplePage973&api-version=7.1

{
  "content": "New content for page"
}

示例响应

状态代码:

200

eTag: "c14ea53eb6fc5921c184be18c6b3d2d916548f28"

{
  "path": "/SamplePage973",
  "order": 1,
  "isParentPage": true,
  "gitItemPath": "/SamplePage973.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_apis/wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925/pages/%2FSamplePage973",
  "remoteUrl": "https://dev.azure.com/fabrikam/e5e9e01e-801a-47eb-80bb-0ad24f448abe/_wiki/wikis/ffa4628c-8f6d-45c0-b61b-52c16d06c925?pagePath=%2FSamplePage973",
  "id": 51,
  "content": "New content for page"
}

定义

名称	说明
GitVersionOptions	版本选项 - 指定版本的其他修饰符（例如上一个）
GitVersionType	版本类型（分支、标记或提交）。 确定如何解释 ID
WikiPage	定义 Wiki 中的页面。
WikiPageCreateOrUpdateParameters	封装页面创建或更新作的参数的协定。

GitVersionOptions

枚举

版本选项 - 指定版本的其他修饰符（例如上一个）

值	说明
firstParent	提交的第一个父级 （HEAD^）
none	未指定
previousChange	提交在当前版本之前更改的项

GitVersionType

枚举

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

值	说明
branch	将版本解释为分支名称
commit	将版本解释为提交 ID （SHA1）
tag	将版本解释为标记名称

WikiPage

Object

定义 Wiki 中的页面。

名称	类型	说明
content	string	Wiki 页面的内容。
gitItemPath	string	对应于支持 Git 存储库中存储的 Wiki 页面的 git 项的路径。
id	integer (int32)	存在时，Wiki 页面的永久标识符
isNonConformant	boolean	如此 如果页面不符合，即 1） 如果名称与页面命名标准不匹配。 2） 如果页面在适当的顺序文件中没有有效的条目，则为 2。
isParentPage	boolean	如此 如果此页面在其路径下有子页。
order	integer (int32)	Wiki 页面的顺序，相对于同一层次结构级别中的其他页面。
path	string	Wiki 页面的路径。
remoteUrl	string	Wiki 页面的远程 Web URL。
subPages	WikiPage[]	当前页的子页列表。
url	string	此 Wiki 页面的 REST URL。

WikiPageCreateOrUpdateParameters

Object

封装页面创建或更新作的参数的协定。

名称	类型	说明
content	string	Wiki 页面的内容。