Feature Flags API

原文：https://docs.gitlab.com/ee/api/feature_flags.html

• Feature Flags pagination
• List feature flags for a project
• Get a single feature flag
• Create a feature flag
• Update a feature flag
• Delete a feature flag

Feature Flags API

Introduced in GitLab Premium 12.5.

注意：此 API 位于功能标志的后面. 如果您的环境中未启用此标志，则可以使用旧功能标志 API .

用于访问GitLab 功能标记资源的 API.

具有开发者或更高权限的用户可以访问功能标记 API.

Feature Flags pagination

默认情况下，因为 API 结果是分页的 ，所以GET请求一次返回 20 个结果.

List feature flags for a project

获取所请求项目的所有功能标志.

GET /projects/:id/feature_flags

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",  "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"  }  ]  }  ]  },  {  "name":"new_live_trace",  "description":"This is a new live trace feature",  "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"  }  ]  }  ]  }  ]

Get a single feature flag

获取单个功能标志.

GET /projects/:id/feature_flags/:name

curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature

响应示例：

{  "name":  "awesome_feature",  "description":  null,  "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"  }  ]  }  ]  }

Create a feature flag

创建一个新的功能标志.

POST /projects/:id/feature_flags

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,  "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"  }  ]  }  ]  }

Update a feature flag

更新功能标志.

PUT /projects/:id/feature_flags/:name

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,  "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 a feature flag

删除功能标志.

DELETE /projects/:id/feature_flags/:name

curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags/awesome_feature"