Skip to content

add api spec for feature flags allocations and exposure schedules endpoints #3683

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
Open

add api spec for feature flags allocations and exposure schedules endpoints #3683

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
1,224 changes: 1,224 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions examples/v2/feature-flags/CreateAllocationsForFeatureFlagInEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
// Create targeting rules for a flag env returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationDataRequest;
import com.datadog.api.client.v2.model.AllocationDataType;
import com.datadog.api.client.v2.model.AllocationResponse;
import com.datadog.api.client.v2.model.AllocationType;
import com.datadog.api.client.v2.model.ConditionOperator;
import com.datadog.api.client.v2.model.ConditionRequest;
import com.datadog.api.client.v2.model.CreateAllocationsRequest;
import com.datadog.api.client.v2.model.ExposureRolloutStepRequest;
import com.datadog.api.client.v2.model.ExposureScheduleRequest;
import com.datadog.api.client.v2.model.GuardrailMetricRequest;
import com.datadog.api.client.v2.model.GuardrailTriggerAction;
import com.datadog.api.client.v2.model.RolloutOptionsRequest;
import com.datadog.api.client.v2.model.RolloutStrategy;
import com.datadog.api.client.v2.model.TargetingRuleRequest;
import com.datadog.api.client.v2.model.UpsertAllocationRequest;
import com.datadog.api.client.v2.model.VariantWeightRequest;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

CreateAllocationsRequest body =
new CreateAllocationsRequest()
.data(
new AllocationDataRequest()
.attributes(
new UpsertAllocationRequest()
.experimentId("550e8400-e29b-41d4-a716-446655440030")
.exposureSchedule(
new ExposureScheduleRequest()
.absoluteStartTime(OffsetDateTime.parse("2025-06-13T12:00:00Z"))
.controlVariantId("550e8400-e29b-41d4-a716-446655440012")
.controlVariantKey("control")
.id(UUID.fromString("550e8400-e29b-41d4-a716-446655440010"))
.rolloutOptions(
new RolloutOptionsRequest()
.autostart(false)
.selectionIntervalMs(3600000L)
.strategy(RolloutStrategy.UNIFORM_INTERVALS))
.rolloutSteps(
Collections.singletonList(
new ExposureRolloutStepRequest()
.exposureRatio(0.5)
.groupedStepIndex(1L)
.id(
UUID.fromString(
"550e8400-e29b-41d4-a716-446655440040"))
.intervalMs(3600000L)
.isPauseRecord(false))))
.guardrailMetrics(
Collections.singletonList(
new GuardrailMetricRequest()
.metricId("metric-error-rate")
.triggerAction(GuardrailTriggerAction.PAUSE)))
.id(UUID.fromString("550e8400-e29b-41d4-a716-446655440020"))
.key("prod-rollout")
.name("Production Rollout")
.targetingRules(
Collections.singletonList(
new TargetingRuleRequest()
.conditions(
Collections.singletonList(
new ConditionRequest()
.attribute("user_tier")
.operator(ConditionOperator.ONE_OF)
.value(
Arrays.asList("premium", "enterprise"))))))
.type(AllocationType.FEATURE_GATE)
.variantWeights(
Collections.singletonList(
new VariantWeightRequest()
.value(50.0)
.variantId(
UUID.fromString("550e8400-e29b-41d4-a716-446655440001"))
.variantKey("control"))))
.type(AllocationDataType.ALLOCATIONS));

try {
AllocationResponse result =
apiInstance.createAllocationsForFeatureFlagInEnvironment(
UUID.fromString("550e8400-e29b-41d4-a716-446655440000"),
UUID.fromString("550e8400-e29b-41d4-a716-446655440001"),
body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling FeatureFlagsApi#createAllocationsForFeatureFlagInEnvironment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
74 changes: 74 additions & 0 deletions examples/v2/feature-flags/CreateAllocationsForFeatureFlagInEnvironment_3662093014.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
// Create allocation for a flag in an environment returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationDataRequest;
import com.datadog.api.client.v2.model.AllocationDataType;
import com.datadog.api.client.v2.model.AllocationResponse;
import com.datadog.api.client.v2.model.AllocationType;
import com.datadog.api.client.v2.model.CreateAllocationsRequest;
import com.datadog.api.client.v2.model.UpsertAllocationRequest;
import com.datadog.api.client.v2.model.VariantWeightRequest;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

// there is a valid "feature_flag" in the system
UUID FEATURE_FLAG_DATA_ATTRIBUTES_VARIANTS_0_ID = null;
try {
FEATURE_FLAG_DATA_ATTRIBUTES_VARIANTS_0_ID =
UUID.fromString(System.getenv("FEATURE_FLAG_DATA_ATTRIBUTES_VARIANTS_0_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
UUID FEATURE_FLAG_DATA_ID = null;
try {
FEATURE_FLAG_DATA_ID = UUID.fromString(System.getenv("FEATURE_FLAG_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

// there is a valid "environment" in the system
UUID ENVIRONMENT_DATA_ID = null;
try {
ENVIRONMENT_DATA_ID = UUID.fromString(System.getenv("ENVIRONMENT_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

CreateAllocationsRequest body =
new CreateAllocationsRequest()
.data(
new AllocationDataRequest()
.type(AllocationDataType.ALLOCATIONS)
.attributes(
new UpsertAllocationRequest()
.name("New targeting rule Example-Feature-Flag")
.key("new-targeting-rule-example-feature-flag")
.variantWeights(
Collections.singletonList(
new VariantWeightRequest()
.variantId(FEATURE_FLAG_DATA_ATTRIBUTES_VARIANTS_0_ID)
.value(100.0)))
.type(AllocationType.CANARY)));

try {
AllocationResponse result =
apiInstance.createAllocationsForFeatureFlagInEnvironment(
FEATURE_FLAG_DATA_ID, ENVIRONMENT_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling FeatureFlagsApi#createAllocationsForFeatureFlagInEnvironment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/feature-flags/PauseExposureSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Pause a progressive rollout returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationExposureScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

try {
AllocationExposureScheduleResponse result =
apiInstance.pauseExposureSchedule(
UUID.fromString("550e8400-e29b-41d4-a716-446655440010"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagsApi#pauseExposureSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/feature-flags/ResumeExposureSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Resume a progressive rollout returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationExposureScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

try {
AllocationExposureScheduleResponse result =
apiInstance.resumeExposureSchedule(
UUID.fromString("550e8400-e29b-41d4-a716-446655440010"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagsApi#resumeExposureSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/feature-flags/StartExposureSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Start a progressive rollout returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationExposureScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

try {
AllocationExposureScheduleResponse result =
apiInstance.startExposureSchedule(
UUID.fromString("550e8400-e29b-41d4-a716-446655440010"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagsApi#startExposureSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/feature-flags/StopExposureSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Stop a progressive rollout returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationExposureScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

try {
AllocationExposureScheduleResponse result =
apiInstance.stopExposureSchedule(UUID.fromString("550e8400-e29b-41d4-a716-446655440010"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FeatureFlagsApi#stopExposureSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
108 changes: 108 additions & 0 deletions examples/v2/feature-flags/UpdateAllocationsForFeatureFlagInEnvironment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
// Update targeting rules for a flag returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FeatureFlagsApi;
import com.datadog.api.client.v2.model.AllocationDataRequest;
import com.datadog.api.client.v2.model.AllocationDataType;
import com.datadog.api.client.v2.model.AllocationType;
import com.datadog.api.client.v2.model.ConditionOperator;
import com.datadog.api.client.v2.model.ConditionRequest;
import com.datadog.api.client.v2.model.ExposureRolloutStepRequest;
import com.datadog.api.client.v2.model.ExposureScheduleRequest;
import com.datadog.api.client.v2.model.GuardrailMetricRequest;
import com.datadog.api.client.v2.model.GuardrailTriggerAction;
import com.datadog.api.client.v2.model.ListAllocationsResponse;
import com.datadog.api.client.v2.model.OverwriteAllocationsRequest;
import com.datadog.api.client.v2.model.RolloutOptionsRequest;
import com.datadog.api.client.v2.model.RolloutStrategy;
import com.datadog.api.client.v2.model.TargetingRuleRequest;
import com.datadog.api.client.v2.model.UpsertAllocationRequest;
import com.datadog.api.client.v2.model.VariantWeightRequest;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
FeatureFlagsApi apiInstance = new FeatureFlagsApi(defaultClient);

OverwriteAllocationsRequest body =
new OverwriteAllocationsRequest()
.data(
Collections.singletonList(
new AllocationDataRequest()
.attributes(
new UpsertAllocationRequest()
.experimentId("550e8400-e29b-41d4-a716-446655440030")
.exposureSchedule(
new ExposureScheduleRequest()
.absoluteStartTime(
OffsetDateTime.parse("2025-06-13T12:00:00Z"))
.controlVariantId("550e8400-e29b-41d4-a716-446655440012")
.controlVariantKey("control")
.id(UUID.fromString("550e8400-e29b-41d4-a716-446655440010"))
.rolloutOptions(
new RolloutOptionsRequest()
.autostart(false)
.selectionIntervalMs(3600000L)
.strategy(RolloutStrategy.UNIFORM_INTERVALS))
.rolloutSteps(
Collections.singletonList(
new ExposureRolloutStepRequest()
.exposureRatio(0.5)
.groupedStepIndex(1L)
.id(
UUID.fromString(
"550e8400-e29b-41d4-a716-446655440040"))
.intervalMs(3600000L)
.isPauseRecord(false))))
.guardrailMetrics(
Collections.singletonList(
new GuardrailMetricRequest()
.metricId("metric-error-rate")
.triggerAction(GuardrailTriggerAction.PAUSE)))
.id(UUID.fromString("550e8400-e29b-41d4-a716-446655440020"))
.key("prod-rollout")
.name("Production Rollout")
.targetingRules(
Collections.singletonList(
new TargetingRuleRequest()
.conditions(
Collections.singletonList(
new ConditionRequest()
.attribute("user_tier")
.operator(ConditionOperator.ONE_OF)
.value(
Arrays.asList(
"premium", "enterprise"))))))
.type(AllocationType.FEATURE_GATE)
.variantWeights(
Collections.singletonList(
new VariantWeightRequest()
.value(50.0)
.variantId(
UUID.fromString(
"550e8400-e29b-41d4-a716-446655440001"))
.variantKey("control"))))
.type(AllocationDataType.ALLOCATIONS)));

try {
ListAllocationsResponse result =
apiInstance.updateAllocationsForFeatureFlagInEnvironment(
UUID.fromString("550e8400-e29b-41d4-a716-446655440000"),
UUID.fromString("550e8400-e29b-41d4-a716-446655440001"),
body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling FeatureFlagsApi#updateAllocationsForFeatureFlagInEnvironment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading