2.14. repository

リポジトリーを一覧表示、作成、管理します。

2.14.1. createRepo

新規リポジトリーを作成します。

POST /api/v1/repository

承認: oauth2_implicit(repo:create)

要求の body スキーマ (application/json)

新規リポジトリーの説明

名前説明スキーマ

repository
任意

リポジトリー名

string

visibility
任意

リポジトリーの初期の表示内容

string

namespace
任意

リポジトリーを作成する namespace。省略すると、呼び出し元のユーザー名が使用されます。

string

description
任意

リポジトリーの Markdown でエンコードされた説明

string

repo_kind
任意

リポジトリーの種類

 
応答
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.2. listRepos

さまざまな状況で現在のユーザーに表示されるリポジトリーの一覧を取得します。

GET /api/v1/repository

承認: oauth2_implicit(repo:read)

クエリーパラメーター
タイプ名前説明スキーマ

query

next_page
任意

次のページのページトークン

string

query

repo_kind
任意

返すリポジトリーの種類

string

query

popularity
任意

リポジトリーの人気指標を含めるかどうか。

boolean

query

last_modified
任意

リポジトリーの最終変更時を含めるかどうか。

boolean

query

public
任意

公開されているリポジトリーをユーザーに表示するように追加します。

boolean

query

starred
任意

ユーザーがスターをつけたリポジトリーを返すようにフィルタリングします。

boolean

query

namespace
任意

この namespace に返されたリポジトリーをフィルターします。

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.3. changeRepoVisibility

リポジトリーの可視性を変更します。

POST /api/v1/repository/{repository}/changevisibility

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

要求の body スキーマ (application/json)

リポジトリーの可視性を変更します。

名前説明スキーマ

visibility
任意

リポジトリーの初期の表示内容

string

レスポンス
HTTP コード説明スキーマ

201

作成に成功

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.4. changeRepoState

リポジトリーの状態を変更します。

PUT /api/v1/repository/{repository}/changestate

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

要求の body スキーマ (application/json)

リポジトリーの状態を変更します。

名前説明スキーマ

state
任意

プッシュが許可されるかどうかを決定します。

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.5. getRepo

指定したリポジトリーを取得します。

GET /api/v1/repository/{repository}

承認: oauth2_implicit(repo:read)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

クエリーパラメーター
タイプ名前説明スキーマ

query

includeTags
任意

リポジトリータグを含めるかどうか

boolean

query

includeStats
任意

アクション統計を含めるかどうか。

boolean

応答
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.6. updateRepo

指定したリポジトリーにある説明を更新します。

PUT /api/v1/repository/{repository}

承認: oauth2_implicit (repo:write)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

要求の body スキーマ (application/json)

リポジトリーで更新できるフィールド。

名前説明スキーマ

description
任意

リポジトリーの Markdown でエンコードされた説明

string

レスポンス
HTTP コード説明スキーマ

200

正常な呼び出し

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError

2.14.7. deleteRepository

リポジトリーを削除します。

DELETE /api/v1/repository/{repository}

承認: oauth2_implicit(repo:admin)

パスパラメーター
タイプ名前説明スキーマ

path

repository
必須

リポジトリーの完全パス (例: namespace/name)

string

レスポンス
HTTP コード説明スキーマ

204

削除済み

 

400

Bad Request (不適切な要求)

ApiError

401

セッションが必要

ApiError

403

不正アクセス

ApiError

404

結果が見つからない

ApiError