Skip to content

Commit 5e276c9

Browse files
dd-octo-sts[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 4a856c9 of spec repo (#4270)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4b31e70 commit 5e276c9

8 files changed

Lines changed: 22 additions & 22 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7356,12 +7356,12 @@ components:
73567356
$ref: "#/components/schemas/GuardrailMetric"
73577357
type: array
73587358
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."
73607360
example: "550e8400-e29b-41d4-a716-446655440020"
73617361
format: uuid
73627362
type: string
73637363
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."
73657365
example: "prod-rollout"
73667366
type: string
73677367
name:
@@ -7419,7 +7419,7 @@ components:
74197419
attributes:
74207420
$ref: "#/components/schemas/Allocation"
74217421
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."
74237423
example: "550e8400-e29b-41d4-a716-446655440020"
74247424
format: uuid
74257425
type: string
@@ -7554,7 +7554,7 @@ components:
75547554
nullable: true
75557555
type: string
75567556
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."
75587558
example: "550e8400-e29b-41d4-a716-446655440020"
75597559
format: uuid
75607560
type: string
@@ -48004,7 +48004,7 @@ components:
4800448004
nullable: true
4800548005
properties:
4800648006
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."
4800848008
type: string
4800948009
entry_point:
4801048010
$ref: >-
@@ -51236,7 +51236,7 @@ components:
5123651236
nullable: true
5123751237
type: object
5123851238
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."
5124051240
example: "allocation-default-123abc"
5124151241
type: string
5124251242
default_variant_id:
@@ -51272,7 +51272,7 @@ components:
5127251272
example: false
5127351273
type: boolean
5127451274
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."
5127651276
example: "allocation-override-123abc"
5127751277
type: string
5127851278
override_variant_id:
@@ -51299,7 +51299,7 @@ components:
5129951299
description: Environment-specific settings for a feature flag in list responses.
5130051300
properties:
5130151301
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."
5130351303
example: "allocation-default-123abc"
5130451304
type: string
5130551305
default_variant_id:
@@ -51335,7 +51335,7 @@ components:
5133551335
example: false
5133651336
type: boolean
5133751337
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."
5133951339
example: "allocation-override-123abc"
5134051340
type: string
5134151341
override_variant_id:
@@ -142291,12 +142291,12 @@ components:
142291142291
$ref: "#/components/schemas/GuardrailMetricRequest"
142292142292
type: array
142293142293
id:
142294-
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."
142295142295
example: "550e8400-e29b-41d4-a716-446655440020"
142296142296
format: uuid
142297142297
type: string
142298142298
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."
142300142300
example: "prod-rollout"
142301142301
type: string
142302142302
name:

‎src/datadog_api_client/v2/model/allocation.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ def __init__(
100100
:param guardrail_metrics: Guardrail metrics associated with this targeting rule allocation.
101101
:type guardrail_metrics: [GuardrailMetric]
102102
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.
104104
:type id: UUID, optional
105105
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.
107107
:type key: str
108108
109109
:param name: The display name of the targeting rule.

‎src/datadog_api_client/v2/model/allocation_data_response.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def __init__(self_, attributes: Allocation, id: UUID, type: AllocationDataType,
4242
:param attributes: Targeting rule (allocation) details for a feature flag environment.
4343
:type attributes: Allocation
4444
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.
4646
:type id: UUID
4747
4848
:param type: The resource type.

‎src/datadog_api_client/v2/model/allocation_exposure_schedule.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def __init__(
7575
:param absolute_start_time: The absolute UTC start time for this schedule.
7676
:type absolute_start_time: datetime, none_type, optional
7777
78-
: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.
7979
:type allocation_id: UUID
8080
8181
:param control_variant_id: The control variant ID used for experiment comparisons.

‎src/datadog_api_client/v2/model/experiments_patch_experiment_v2_response_data_attributes_datadog_flag_configuration.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def __init__(
6161
"""
6262
Feature flag, environment, and targeting configuration for the experiment.
6363
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.
6565
:type allocation_key: str, optional
6666
6767
:param entry_point: Datadog measure and filters used to select analyzed subjects.

‎src/datadog_api_client/v2/model/feature_flag_environment.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def __init__(
9797
:param allocations: Allocation metadata for this environment.
9898
:type allocations: {str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, none_type, optional
9999
100-
: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.
101101
:type default_allocation_key: str, optional
102102
103103
:param default_variant_id: The ID of the default variant for this environment.
@@ -118,7 +118,7 @@ def __init__(
118118
:param observe_full_evaluation_data: Indicates whether feature flag evaluation events include original targeting identifiers and full evaluation context.
119119
:type observe_full_evaluation_data: bool, optional
120120
121-
: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.
122122
:type override_allocation_key: str, optional
123123
124124
:param override_variant_id: The ID of the override variant for this environment.

‎src/datadog_api_client/v2/model/feature_flag_environment_list_item.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def __init__(
7373
"""
7474
Environment-specific settings for a feature flag in list responses.
7575
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.
7777
:type default_allocation_key: str, optional
7878
7979
:param default_variant_id: The ID of the default variant for this environment.
@@ -94,7 +94,7 @@ def __init__(
9494
:param observe_full_evaluation_data: Indicates whether feature flag evaluation events include original targeting identifiers and full evaluation context.
9595
:type observe_full_evaluation_data: bool, optional
9696
97-
: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.
9898
:type override_allocation_key: str, optional
9999
100100
:param override_variant_id: The ID of the override variant for this environment.

‎src/datadog_api_client/v2/model/upsert_allocation_request.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,10 @@ def __init__(
8181
:param guardrail_metrics: Guardrail metrics used to monitor and auto-pause or abort.
8282
:type guardrail_metrics: [GuardrailMetricRequest], optional
8383
84-
: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.
8585
:type id: UUID, optional
8686
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.
8888
:type key: str
8989
9090
:param name: The display name of the targeting rule.

0 commit comments

Comments
 (0)