wiki リソース

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Bitbucket Cloud v1 APIs are deprecated

Bitbucket Cloud REST API version 1 is deprecated effective 30 June 2018. All 1.0 APIs will be removed from the REST API permanently on 31 December 2018. Read the deprecation notice. Or you can jump right to the version 2.0 REST API documentation.

概要

wiki リソースを使用すると、Bitbucket wiki のページから情報を取得したり、新しいページを作成したり、ページを更新する機能を利用できます。

Wiki ページの元のコンテンツの取得

wiki ページと最新のリビジョンのコンテンツを取得します。取得するページのタイトルを指定する必要があります。ページを取得する際には、拡張子 .wiki は含めません。page 値を指定しない場合、既定は Home ページになります。

応答には、次のいずれかの markup フィールドが含まれます。

  • マークダウン
  • Creole
  • REST
  • Textile
  • NULL

Bitbucket はページの拡張子に基づいて、Wiki で使用されているマークアップ形式を判断します。拡張子がない場合、ファイル タイプが正確ではない場合があります。このような場合、markdown として表示されます。

curl --user accountname:password https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/wiki/{page}
ここをクリックして展開...

{

"data": "This is inline text: {{{<<file index.html>>}}}followed by more.\n\nTrying to get back to the tutorial for this project?It's here: https://confluence.atlassian.com/display/BITBUCKET/Bitbucket+101\n\n[Two](Two)",

"markup": "markdown",

"rev": "e9247a427a2eba5fa01158ea4aedb6045f2a59dc"

}

新しいページの投稿

新しい wiki ページを作成します。次のパラメータを指定する必要があります。

パラメーター 説明
ページ ページのタイトル。
data ページのコンテンツ。

呼び出し元は、wiki へのアクセス権を持つアカウントとして認証を行う必要があります。

curl --user accountname:password https://api.bitbucket.org/1.0/repositories/{accountname}/{repo_slug}/wiki/{page} --data "content=string"

ページを更新する

既存の wiki ページを更新します。次のパラメータを指定する必要があります。

パラメーター 必須 説明
ページ はい ページのタイトル。
path はい ページへのパス。
data はい ページのコンテンツ。
rev いいえ

ファイルの変更前のリビジョン。既存のすべてのコンテンツを上書きする場合、この値を省略します。

個別の wiki ページの同時変更を停止したい場合はこのパラメータを指定します。rev と wiki ページを指定した場合、その時点の rev と一致しないため、編集は失敗します。

呼び出し元は、wiki へのアクセス権を持つアカウントとして認証を行う必要があります。

curl --user accountname:password https://api.bitbucket.org/1.0/repositories/accountname/repo_name/wiki/{page} --data "path={path}&data=string" --data "rev=value"
最終更新日 2018 年 6 月 14 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.