Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
c1560c0b
Commit
c1560c0b
authored
May 13, 2020
by
Alper Akgun
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Documentation for % of actors rollout
parent
a1478b2f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
42 additions
and
0 deletions
+42
-0
doc/api/features.md
doc/api/features.md
+42
-0
No files found.
doc/api/features.md
View file @
c1560c0b
...
...
@@ -31,6 +31,16 @@ Example response:
}
]
},
{
"name"
:
"my_user_feature"
,
"state"
:
"on"
,
"gates"
:
[
{
"key"
:
"percentage_of_actors"
,
"value"
:
34
}
]
},
{
"name"
:
"new_library"
,
"state"
:
"on"
,
...
...
@@ -58,6 +68,7 @@ POST /features/:name
| --------- | ---- | -------- | ----------- |
|
`name`
| string | yes | Name of the feature to create or update |
|
`value`
| integer/string | yes |
`true`
or
`false`
to enable/disable, or an integer for percentage of time |
|
`key`
| string | no |
`percentage_of_actors`
or
`percentage_of_time`
(default) |
|
`feature_group`
| string | no | A Feature group name |
|
`user`
| string | no | A GitLab username |
|
`group`
| string | no | A GitLab group's path, for example
`gitlab-org`
|
...
...
@@ -89,6 +100,37 @@ Example response:
}
```
### Set percentage of actors rollout
Rollout to percentage of users.
```
plaintext
POST https://gitlab.example.com/api/v4/features/my_user_feature?private_token=<your_access_token>
Content-Type: application/x-www-form-urlencoded
value=42&key=percentage_of_actors&
```
Example response:
```
json
{
"name"
:
"my_user_feature"
,
"state"
:
"conditional"
,
"gates"
:
[
{
"key"
:
"boolean"
,
"value"
:
false
},
{
"key"
:
"percentage_of_time"
,
"value"
:
42
}
]
}
```
Rolls out the
`my_user_feature`
to
`42%`
of users.
## Delete a feature
Removes a feature gate. Response is equal when the gate exists, or doesn't.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment