2.14. repository
リポジトリーを一覧表示、作成、管理します。
2.14.1. listRepos
さまざまな状況で現在のユーザーに表示されるリポジトリーの一覧を取得します。
GET /api/v1/repository
承認: oauth2_implicit(repo:read)
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
next_page | 次のページのページトークン | string |
| query |
repo_kind | 返すリポジトリーの種類 | string |
| query |
popularity | リポジトリーの人気指標を含めるかどうか。 | ブール値 |
| query |
last_modified | リポジトリーの最終変更時を含めるかどうか。 | ブール値 |
| query |
public | 公開されているリポジトリーをユーザーに表示するように追加します。 | ブール値 |
| query |
starred | ユーザーがスターをつけたリポジトリーを返すようにフィルタリングします。 | ブール値 |
| query |
namespace | この namespace に返されたリポジトリーをフィルターします。 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.2. createRepo
新規リポジトリーを作成します。
POST /api/v1/repository
承認: oauth2_implicit(repo:create)
要求のボディースキーマ (アプリケーション/json)
新規リポジトリーの説明
| 名前 | 説明 | スキーマ |
|---|---|---|
|
repository | リポジトリー名 | string |
|
visibility | リポジトリーの初期の表示内容 | string |
|
namespace | リポジトリーを作成する namespace。省略すると、呼び出し元のユーザー名が使用されます。 | string |
|
description | リポジトリーの Markdown でエンコードされた説明 | string |
|
repo_kind | リポジトリーの種類 |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.3. changeRepoVisibility
リポジトリーの可視性を変更します。
POST /api/v1/repository/{repository}/changevisibility
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求のボディースキーマ (アプリケーション/json)
リポジトリーの可視性を変更します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
visibility | リポジトリーの初期の表示内容 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 201 | 作成成功 | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.4. changeRepoState
リポジトリーの状態を変更します。
PUT /api/v1/repository/{repository}/changestate
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求のボディースキーマ (アプリケーション/json)
リポジトリーの状態を変更します。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
state | プッシュが許可されるかどうかを決定します。 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.5. getRepo
指定したリポジトリーを取得します。
GET /api/v1/repository/{repository}
承認: oauth2_implicit(repo:read)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
クエリーパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| query |
includeTags | リポジトリータグを含めるかどうか | ブール値 |
| query |
includeStats | アクション統計を含めるかどうか。 | ブール値 |
応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.6. deleteRepository
リポジトリーを削除します。
DELETE /api/v1/repository/{repository}
承認: oauth2_implicit(repo:admin)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 204 | 削除済み | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
2.14.7. updateRepo
指定したリポジトリーにある説明を更新します。
PUT /api/v1/repository/{repository}
承認: oauth2_implicit (repo:write)
パスパラメーター
| タイプ | 名前 | 説明 | スキーマ |
|---|---|---|---|
| path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求のボディースキーマ (アプリケーション/json)
リポジトリーで更新できるフィールド。
| 名前 | 説明 | スキーマ |
|---|---|---|
|
description | リポジトリーの Markdown でエンコードされた説明 | string |
レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 正常な呼び出し | |
| 400 | 不適切な要求 | |
| 401 | セッションが必要 | |
| 403 | 不正アクセス | |
| 404 | 結果が見つからない |
