リポジトリの更新(by ID)

Prev Next

Classic/VPC環境で利用できます。

リポジトリ IDを利用してそのリポジトリの設定を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PATCH /api/v1/repository/id/{repositoryId}

リクエストヘッダ

SourceCommit APIで共通して使用されるヘッダの詳細は、SourceCommitのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
repositoryId String Required リポジトリ ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
description String Optional リポジトリの説明(Byte)
  • 0~500
linked Object Optional サービス連携情報
linked.FileSafer Boolean Optional File Saferサービス連携
  • true | false (デフォルト)
    • true: 連携
    • false: 連携しない
linked.ObjectStorage Boolean Optional Object Storageサービス連携
  • true | false (デフォルト)
    • true: 連携
    • false: 連携しない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PATCH 'https://sourcecommit.apigw.ntruss.com/api/v1/repository/id/632***' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "description": "repository001",
  "linked": {
    "FileSafer": true,
    "ObjectStorage": false
  }
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result Boolean - API呼び出しは成功したか
  • 成功した場合、trueと表示
  • 失敗した場合、フィールドは表示されない

レスポンスステータスコード

SourceCommit APIで共通して使用されるレスポンスステータスコードの詳細は、SourceCommitのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": true
}