2.15. repository
リポジトリーをリスト表示、作成、管理します。
2.15.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 | リポジトリーの種類 |
応答
2.15.2. listRepos リンクのコピーリンクがクリップボードにコピーされました!
さまざまな状況で現在のユーザーに表示されるリポジトリーのリストを取得します。
GET /api/v1/repository
承認: oauth2_implicit(repo:read)
クエリーパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
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 |
レスポンス
2.15.3. changeRepoVisibility リンクのコピーリンクがクリップボードにコピーされました!
リポジトリーの可視性を変更します。
POST /api/v1/repository/{repository}/changevisibility
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求の body スキーマ (application/json)
リポジトリーの可視性を変更します。
名前 | Description | スキーマ |
---|---|---|
visibility | リポジトリーの初期の表示内容 | string |
レスポンス
2.15.4. changeRepoState リンクのコピーリンクがクリップボードにコピーされました!
リポジトリーの状態を変更します。
PUT /api/v1/repository/{repository}/changestate
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求の body スキーマ (application/json)
リポジトリーの状態を変更します。
名前 | Description | スキーマ |
---|---|---|
state | プッシュが許可されるかどうかを決定します。 | string |
レスポンス
2.15.5. getRepo リンクのコピーリンクがクリップボードにコピーされました!
指定したリポジトリーを取得します。
GET /api/v1/repository/{repository}
承認: oauth2_implicit(repo:read)
パスパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
クエリーパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
query |
includeTags | リポジトリータグを含めるかどうか | boolean |
query |
includeStats | アクション統計を含めるかどうか。 | boolean |
応答
2.15.6. updateRepo リンクのコピーリンクがクリップボードにコピーされました!
指定したリポジトリーにある説明を更新します。
PUT /api/v1/repository/{repository}
承認: oauth2_implicit (repo:write)
パスパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |
要求の body スキーマ (application/json)
リポジトリーで更新できるフィールド。
名前 | Description | スキーマ |
---|---|---|
description | リポジトリーの Markdown でエンコードされた説明 | string |
レスポンス
2.15.7. deleteRepository リンクのコピーリンクがクリップボードにコピーされました!
リポジトリーを削除します。
DELETE /api/v1/repository/{repository}
承認: oauth2_implicit(repo:admin)
パスパラメーター
タイプ | Name | Description | スキーマ |
---|---|---|---|
path |
repository | リポジトリーの完全パス (例: namespace/name) | string |