Skip to content

Clarify feature flag targeting rule permissions #4208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −5
Open

Clarify feature flag targeting rule permissions #4208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117110,7 +117110,10 @@ components:
description: Request to create or update a targeting rule (allocation) for a feature flag environment.
properties:
experiment_id:
description: The experiment ID for experiment-linked allocations.
description: |-
The experiment ID linked to the allocation. For `FEATURE_GATE` allocations,
a non-null value denotes a standard experiment. For `CANARY` allocations,
Datadog manages this value. Omit it when creating a canary allocation.
example: "550e8400-e29b-41d4-a716-446655440030"
nullable: true
type: string
Expand Down Expand Up @@ -144699,6 +144702,11 @@ paths:
description: |-
Updates targeting rules (allocations) for a specific feature flag in a specific environment.
This operation replaces the existing allocation set with the request payload.
Creating, updating, or deleting a standard experiment allocation—an allocation with
`type: FEATURE_GATE` and a non-null `experiment_id`—also requires the
`product_analytics_experiments_write` permission. This additional permission is not
required for `CANARY` allocations, exposure schedules, or guardrail metrics unless
the same operation also mutates a standard experiment allocation.
operationId: UpdateAllocationsForFeatureFlagInEnvironment
parameters:
- $ref: "#/components/parameters/feature_flag_id"
Expand Down Expand Up @@ -144772,7 +144780,9 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Forbidden
description: |-
Forbidden. The caller is missing the `feature_flag_config_write` permission.
This error is also returned when the operation mutates a standard experiment allocation and the caller is missing the `product_analytics_experiments_write` permission.
"404":
content:
application/json:
Expand Down
9 changes: 7 additions & 2 deletions src/main/java/com/datadog/api/client/v2/api/FeatureFlagsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3006,7 +3006,12 @@ public ListAllocationsResponse updateAllocationsForFeatureFlagInEnvironment(

/**
* Updates targeting rules (allocations) for a specific feature flag in a specific environment.
* This operation replaces the existing allocation set with the request payload.
* This operation replaces the existing allocation set with the request payload. Creating,
* updating, or deleting a standard experiment allocation—an allocation with <code>
* type: FEATURE_GATE</code> and a non-null <code>experiment_id</code>—also requires the <code>
* product_analytics_experiments_write</code> permission. This additional permission is not
* required for <code>CANARY</code> allocations, exposure schedules, or guardrail metrics unless
* the same operation also mutates a standard experiment allocation.
*
* @param featureFlagId The ID of the feature flag. (required)
* @param environmentId The ID of the environment. (required)
Expand All @@ -3020,7 +3025,7 @@ public ListAllocationsResponse updateAllocationsForFeatureFlagInEnvironment(
* <tr><td> 200 </td><td> OK </td><td> - </td></tr>
* <tr><td> 202 </td><td> Accepted - Approval required for this change </td><td> - </td></tr>
* <tr><td> 400 </td><td> Bad Request </td><td> - </td></tr>
* <tr><td> 403 </td><td> Forbidden </td><td> - </td></tr>
* <tr><td> 403 </td><td> Forbidden. The caller is missing the &#x60;feature_flag_config_write&#x60; permission. This error is also returned when the operation mutates a standard experiment allocation and the caller is missing the &#x60;product_analytics_experiments_write&#x60; permission. </td><td> - </td></tr>
* <tr><td> 404 </td><td> Not Found </td><td> - </td></tr>
* <tr><td> 409 </td><td> Conflict </td><td> - </td></tr>
* <tr><td> 429 </td><td> Too many requests </td><td> - </td></tr>
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/UpsertAllocationRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ public UpsertAllocationRequest experimentId(String experimentId) {
}

/**
* The experiment ID for experiment-linked allocations.
* The experiment ID linked to the allocation. For <code>FEATURE_GATE</code> allocations, a
* non-null value denotes a standard experiment. For <code>CANARY</code> allocations, Datadog
* manages this value. Omit it when creating a canary allocation.
*
* @return experimentId
*/
Expand Down
Loading