機能フラグAPI

GitLab機能フラグのリソースにアクセスするためのAPI。

少なくとも Developerロールを持つユーザーは機能フラグ API にアクセスできます。

機能フラグのページネーション

デフォルトでは、API の結果はページ分割されているため、GET リクエストは一度に 20 件の結果を返します。

プロジェクトの機能フラグ一覧

要求されたプロジェクトのすべての機能フラグを取得します。

GET /projects/:id/feature_flags
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
scope文字列です。いいえ機能フラグの条件：enabled disabled.
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags"

応答例

[
   {
      "name":"merge_train",
      "description":"This feature is about merge train",
      "active": true,
      "version": "new_version_flag",
      "created_at":"2019-11-04T08:13:51.423Z",
      "updated_at":"2019-11-04T08:13:51.423Z",
      "scopes":[],
      "strategies": [
        {
          "id": 1,
          "name": "userWithId",
          "parameters": {
            "userIds": "user1"
          },
          "scopes": [
            {
              "id": 1,
              "environment_scope": "production"
            }
          ],
          "user_list": null
        }
      ]
   },
   {
      "name":"new_live_trace",
      "description":"This is a new live trace feature",
      "active": true,
      "version": "new_version_flag",
      "created_at":"2019-11-04T08:13:10.507Z",
      "updated_at":"2019-11-04T08:13:10.507Z",
      "scopes":[],
      "strategies": [
        {
          "id": 2,
          "name": "default",
          "parameters": {},
          "scopes": [
            {
              "id": 2,
              "environment_scope": "staging"
            }
          ],
          "user_list": null
        }
      ]
   },
   {
      "name":"user_list",
      "description":"This feature is about user list",
      "active": true,
      "version": "new_version_flag",
      "created_at":"2019-11-04T08:13:10.507Z",
      "updated_at":"2019-11-04T08:13:10.507Z",
      "scopes":[],
      "strategies": [
        {
          "id": 2,
          "name": "gitlabUserList",
          "parameters": {},
          "scopes": [
            {
              "id": 2,
              "environment_scope": "staging"
            }
          ],
          "user_list": {
            "id": 1,
            "iid": 1,
            "name": "My user list",
            "user_xids": "user1,user2,user3"
          }
        }
      ]
   }
]

単一機能フラグの取得

単一の機能フラグを取得します。

GET /projects/:id/feature_flags/:feature_flag_name
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
feature_flag_name文字列です。yes機能フラグの名前。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature"

応答例

{
  "name": "awesome_feature",
  "description": null,
  "active": true,
  "version": "new_version_flag",
  "created_at": "2020-05-13T19:56:33.119Z",
  "updated_at": "2020-05-13T19:56:33.119Z",
  "scopes": [],
  "strategies": [
    {
      "id": 36,
      "name": "default",
      "parameters": {},
      "scopes": [
        {
          "id": 37,
          "environment_scope": "production"
        }
      ],
      "user_list": null
    }
  ]
}

機能フラグの作成

新しい機能フラグを作成します。

POST /projects/:id/feature_flags
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
name文字列です。yes機能フラグの名前。
version文字列です。yes機能フラグのバージョン。new_version_flag でなければなりません。レガシー機能フラグを作成する場合は省略してください。
description文字列です。いいえ機能フラグの説明。
activebooleanいいえフラグのアクティビティ状態。デフォルトはtrue。GitLab 13.3 以降でサポート。
strategies戦略JSONオブジェクトの配列いいえ機能フラグ戦略。
strategies:nameJSONいいえストラテジー名。default,gradualRolloutUserId,userWithId, またはgitlabUserListのいずれか。GitLab 13.5以降ではflexibleRolloutのいずれか。
strategies:parametersJSONいいえ戦略パラメータ。
strategies:scopesJSONいいえストラテジーのスコープ。
strategies:scopes:environment_scope文字列です。いいえスコープの環境スコープ。
strategies:user_list_id整数/文字列いいえ機能フラグユーザーリストのID。strategy がgitlabUserListの場合。
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-type: application/json" \
     --data @- << EOF
{
  "name": "awesome_feature",
  "version": "new_version_flag",
  "strategies": [{ "name": "default", "parameters": {}, "scopes": [{ "environment_scope": "production" }] }]
}
EOF

応答例

{
  "name": "awesome_feature",
  "description": null,
  "active": true,
  "version": "new_version_flag",
  "created_at": "2020-05-13T19:56:33.119Z",
  "updated_at": "2020-05-13T19:56:33.119Z",
  "scopes": [],
  "strategies": [
    {
      "id": 36,
      "name": "default",
      "parameters": {},
      "scopes": [
        {
          "id": 37,
          "environment_scope": "production"
        }
      ]
    }
  ]
}

機能フラグの更新

機能フラグを更新します。

PUT /projects/:id/feature_flags/:feature_flag_name
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
feature_flag_name文字列です。yes機能フラグの現在の名前。
description文字列です。いいえ機能フラグの説明。
activebooleanいいえフラグのアクティビティ状態。GitLab 13.3以降でサポート。
name文字列です。いいえ機能フラグの新しい名前。GitLab 13.3以降でサポート。
strategies戦略JSONオブジェクトの配列いいえ機能フラグ戦略。
strategies:idJSONいいえ機能フラグ戦略ID。
strategies:nameJSONいいえストラテジー名。
strategies:_destroybooleanいいえtrueの場合、ストラテジーを削除します。
strategies:parametersJSONいいえ戦略パラメータ。
strategies:scopesJSONいいえストラテジーのスコープ。
strategies:scopes:idJSONいいえ環境スコープID。
strategies:scopes:environment_scope文字列です。いいえスコープの環境スコープ。
strategies:scopes:_destroybooleanいいえtrue の場合、スコープを削除します。
strategies:user_list_id整数/文字列いいえ機能フラグユーザーリストのID。strategy がgitlabUserListの場合。
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-type: application/json" \
     --data @- << EOF
{
  "strategies": [{ "name": "gradualRolloutUserId", "parameters": { "groupId": "default", "percentage": "25" }, "scopes": [{ "environment_scope": "staging" }] }]
}
EOF

応答例

{
  "name": "awesome_feature",
  "description": null,
  "active": true,
  "version": "new_version_flag",
  "created_at": "2020-05-13T20:10:32.891Z",
  "updated_at": "2020-05-13T20:10:32.891Z",
  "scopes": [],
  "strategies": [
    {
      "id": 38,
      "name": "gradualRolloutUserId",
      "parameters": {
        "groupId": "default",
        "percentage": "25"
      },
      "scopes": [
        {
          "id": 40,
          "environment_scope": "staging"
        }
      ]
    },
    {
      "id": 37,
      "name": "default",
      "parameters": {},
      "scopes": [
        {
          "id": 39,
          "environment_scope": "production"
        }
      ]
    }
  ]
}

機能フラグの削除

機能フラグを削除します。

DELETE /projects/:id/feature_flags/:feature_flag_name
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
feature_flag_name文字列です。yes機能フラグの名前。
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature"