You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5e276c9
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .generator/schemas/v2/openapi.yaml
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -7356,12 +7356,12 @@ components:
7356
7356
$ref: "#/components/schemas/GuardrailMetric"
7357
7357
type: array
7358
7358
id:
7359
-
description: The unique identifier of the targeting rule allocation.
7359
+
description: "The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as `/api/v2/allocations/{allocation_id}`. It is not included in SDK evaluation results or exposure events."
7360
7360
example: "550e8400-e29b-41d4-a716-446655440020"
7361
7361
format: uuid
7362
7362
type: string
7363
7363
key:
7364
-
description: The unique key of the targeting rule allocation.
7364
+
description: "The unique key of the targeting rule allocation. SDKs report this key in flag evaluation results and exposure events to indicate which targeting rule assigned the variant. Use it to match evaluation or experiment data to this rule."
7365
7365
example: "prod-rollout"
7366
7366
type: string
7367
7367
name:
@@ -7419,7 +7419,7 @@ components:
7419
7419
attributes:
7420
7420
$ref: "#/components/schemas/Allocation"
7421
7421
id:
7422
-
description: The unique identifier of the targeting rule allocation.
7422
+
description: "The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as `/api/v2/allocations/{allocation_id}`. It is not included in SDK evaluation results or exposure events."
7423
7423
example: "550e8400-e29b-41d4-a716-446655440020"
7424
7424
format: uuid
7425
7425
type: string
@@ -7554,7 +7554,7 @@ components:
7554
7554
nullable: true
7555
7555
type: string
7556
7556
allocation_id:
7557
-
description: The targeting rule allocation ID this progressive rollout belongs to.
7557
+
description: "The unique identifier (UUID) of the targeting rule allocation this progressive rollout belongs to. This is not the allocation key that SDKs report in evaluation results and exposure events."
7558
7558
example: "550e8400-e29b-41d4-a716-446655440020"
7559
7559
format: uuid
7560
7560
type: string
@@ -48004,7 +48004,7 @@ components:
48004
48004
nullable: true
48005
48005
properties:
48006
48006
allocation_key:
48007
-
description: "Key of the feature flag allocation linked to the experiment."
48007
+
description: "Key of the feature flag allocation linked to the experiment. Matches the allocation key that SDKs report in flag evaluation results and exposure events."
48008
48008
type: string
48009
48009
entry_point:
48010
48010
$ref: >-
@@ -51236,7 +51236,7 @@ components:
51236
51236
nullable: true
51237
51237
type: object
51238
51238
default_allocation_key:
51239
-
description: The allocation key used for the default variant.
51239
+
description: "A system-generated allocation key, in the format `allocation-default-<hash>`, that SDKs report in flag evaluation results and exposure events when a subject receives the environment's default variant because no targeting rule matched. It has no corresponding allocation ID and cannot be used with the allocation endpoints."
51240
51240
example: "allocation-default-123abc"
51241
51241
type: string
51242
51242
default_variant_id:
@@ -51272,7 +51272,7 @@ components:
51272
51272
example: false
51273
51273
type: boolean
51274
51274
override_allocation_key:
51275
-
description: The allocation key used for the override variant.
51275
+
description: "A system-generated allocation key, in the format `allocation-override-<hash>`, that SDKs report in flag evaluation results and exposure events when the environment's override variant is served. It has no corresponding allocation ID and cannot be used with the allocation endpoints."
51276
51276
example: "allocation-override-123abc"
51277
51277
type: string
51278
51278
override_variant_id:
@@ -51299,7 +51299,7 @@ components:
51299
51299
description: Environment-specific settings for a feature flag in list responses.
51300
51300
properties:
51301
51301
default_allocation_key:
51302
-
description: The allocation key used for the default variant.
51302
+
description: "A system-generated allocation key, in the format `allocation-default-<hash>`, that SDKs report in flag evaluation results and exposure events when a subject receives the environment's default variant because no targeting rule matched. It has no corresponding allocation ID and cannot be used with the allocation endpoints."
51303
51303
example: "allocation-default-123abc"
51304
51304
type: string
51305
51305
default_variant_id:
@@ -51335,7 +51335,7 @@ components:
51335
51335
example: false
51336
51336
type: boolean
51337
51337
override_allocation_key:
51338
-
description: The allocation key used for the override variant.
51338
+
description: "A system-generated allocation key, in the format `allocation-override-<hash>`, that SDKs report in flag evaluation results and exposure events when the environment's override variant is served. It has no corresponding allocation ID and cannot be used with the allocation endpoints."
description: The unique identifier of the targeting rule allocation.
142294
+
description: "The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as `/api/v2/allocations/{allocation_id}`. It is not included in SDK evaluation results or exposure events."
142295
142295
example: "550e8400-e29b-41d4-a716-446655440020"
142296
142296
format: uuid
142297
142297
type: string
142298
142298
key:
142299
-
description: The unique key of the targeting rule allocation.
142299
+
description: "The unique key of the targeting rule allocation. SDKs report this key in flag evaluation results and exposure events to indicate which targeting rule assigned the variant. Use it to match evaluation or experiment data to this rule."
Copy file name to clipboardExpand all lines: src/datadog_api_client/v2/model/allocation.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -100,10 +100,10 @@ def __init__(
100
100
:param guardrail_metrics: Guardrail metrics associated with this targeting rule allocation.
101
101
:type guardrail_metrics: [GuardrailMetric]
102
102
103
-
:param id: The unique identifier of the targeting rule allocation.
103
+
:param id: The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as ``/api/v2/allocations/{allocation_id}``. It is not included in SDK evaluation results or exposure events.
104
104
:type id: UUID, optional
105
105
106
-
:param key: The unique key of the targeting rule allocation.
106
+
:param key: The unique key of the targeting rule allocation. SDKs report this key in flag evaluation results and exposure events to indicate which targeting rule assigned the variant. Use it to match evaluation or experiment data to this rule.
107
107
:type key: str
108
108
109
109
:param name: The display name of the targeting rule.
:param attributes: Targeting rule (allocation) details for a feature flag environment.
43
43
:type attributes: Allocation
44
44
45
-
:param id: The unique identifier of the targeting rule allocation.
45
+
:param id: The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as ``/api/v2/allocations/{allocation_id}``. It is not included in SDK evaluation results or exposure events.
:param allocation_id: The targeting rule allocation ID this progressive rollout belongs to.
78
+
:param allocation_id: The unique identifier (UUID) of the targeting rule allocation this progressive rollout belongs to. This is not the allocation key that SDKs report in evaluation results and exposure events.
79
79
:type allocation_id: UUID
80
80
81
81
:param control_variant_id: The control variant ID used for experiment comparisons.
Copy file name to clipboardExpand all lines: src/datadog_api_client/v2/model/experiments_patch_experiment_v2_response_data_attributes_datadog_flag_configuration.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ def __init__(
61
61
"""
62
62
Feature flag, environment, and targeting configuration for the experiment.
63
63
64
-
:param allocation_key: Key of the feature flag allocation linked to the experiment.
64
+
:param allocation_key: Key of the feature flag allocation linked to the experiment. Matches the allocation key that SDKs report in flag evaluation results and exposure events.
65
65
:type allocation_key: str, optional
66
66
67
67
:param entry_point: Datadog measure and filters used to select analyzed subjects.
:param default_allocation_key: The allocation key used for the default variant.
100
+
:param default_allocation_key: A system-generated allocation key, in the format ``allocation-default-<hash>`` , that SDKs report in flag evaluation results and exposure events when a subject receives the environment's default variant because no targeting rule matched. It has no corresponding allocation ID and cannot be used with the allocation endpoints.
101
101
:type default_allocation_key: str, optional
102
102
103
103
:param default_variant_id: The ID of the default variant for this environment.
@@ -118,7 +118,7 @@ def __init__(
118
118
:param observe_full_evaluation_data: Indicates whether feature flag evaluation events include original targeting identifiers and full evaluation context.
:param override_allocation_key: The allocation key used for the override variant.
121
+
:param override_allocation_key: A system-generated allocation key, in the format ``allocation-override-<hash>`` , that SDKs report in flag evaluation results and exposure events when the environment's override variant is served. It has no corresponding allocation ID and cannot be used with the allocation endpoints.
122
122
:type override_allocation_key: str, optional
123
123
124
124
:param override_variant_id: The ID of the override variant for this environment.
Copy file name to clipboardExpand all lines: src/datadog_api_client/v2/model/feature_flag_environment_list_item.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ def __init__(
73
73
"""
74
74
Environment-specific settings for a feature flag in list responses.
75
75
76
-
:param default_allocation_key: The allocation key used for the default variant.
76
+
:param default_allocation_key: A system-generated allocation key, in the format ``allocation-default-<hash>`` , that SDKs report in flag evaluation results and exposure events when a subject receives the environment's default variant because no targeting rule matched. It has no corresponding allocation ID and cannot be used with the allocation endpoints.
77
77
:type default_allocation_key: str, optional
78
78
79
79
:param default_variant_id: The ID of the default variant for this environment.
@@ -94,7 +94,7 @@ def __init__(
94
94
:param observe_full_evaluation_data: Indicates whether feature flag evaluation events include original targeting identifiers and full evaluation context.
:param override_allocation_key: The allocation key used for the override variant.
97
+
:param override_allocation_key: A system-generated allocation key, in the format ``allocation-override-<hash>`` , that SDKs report in flag evaluation results and exposure events when the environment's override variant is served. It has no corresponding allocation ID and cannot be used with the allocation endpoints.
98
98
:type override_allocation_key: str, optional
99
99
100
100
:param override_variant_id: The ID of the override variant for this environment.
:param id: The unique identifier of the targeting rule allocation.
84
+
:param id: The unique identifier of the targeting rule allocation. Use this ID with the allocation management endpoints, such as ``/api/v2/allocations/{allocation_id}``. It is not included in SDK evaluation results or exposure events.
85
85
:type id: UUID, optional
86
86
87
-
:param key: The unique key of the targeting rule allocation.
87
+
:param key: The unique key of the targeting rule allocation. SDKs report this key in flag evaluation results and exposure events to indicate which targeting rule assigned the variant. Use it to match evaluation or experiment data to this rule.
88
88
:type key: str
89
89
90
90
:param name: The display name of the targeting rule.
0 commit comments