v17.2.0

[Unreleased] ### Added - Added a new maintainerId field to the input request body of the POST /api/v2/metrics/{projectKey} endpoint - Added a new resourceCategory field to the rep returned by custom roles endpoints and the custom role post body - Added new _presetBundleVersion and _presetStatements fields to the rep returned by custom roles endpoints - Added new query params, aggregationType and contextKind, to the GET /api/v2/usage/mau endpoint - Added a new assignedTo expand parameter to GET /api/v2/roles and GET /api/v2/roles/{customRoleKey} - Added fifteen new AI Configs (beta) endpoints for working with AI Configs, AI Config variations, and AI model configs - Added documentation for the roleAttributes field and expand query parameter on the following endpoints: - GET /api/v2/members - GET /api/v2/members/{memberId} - GET /api/v2/teams - GET /api/v2/teams/{teamKey} - Added documentation for patching the roleAttributes field on the PATCH /api/v2/teams/{teamKey} endpoint - Added a new category field to the Metric response. - Added new public endpoints for working with announcements: - GET /api/v2/announcements - POST /api/v2/announcements - PATCH /api/v2/announcements/{announcementId} - DELETE /api/v2/announcements/{announcementId} - Added a new 'sort' query parameter to GET /api/v2/metric-groups/{projectKey} - Updated the 'filter' query parameter of GET /api/v2/metric-groups/{projectKey} to include 'kind' as a valid option - Added new satisfactionRating field to AI Configs metrics endpoints. - Added new costPerInputToken and costPerInputToken fields to AI Configs Models. - Added new cost metrics to AI Configs Metrics. - Added new endpoint for generating an RSA key pair in order to create a new data warehouse destination - POST /api/v2/destinations/generate-warehouse-destination-key-pair ### Removed - Removed legacy experiment results endpoint GET /api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}} - Removed obsolete isActive field from endpoint POST /api/v2/metrics/{projectKey} ### Changed - Updated the Data Export destination endpoints to include a new destination kind - Expose waitOnApprovals request parameter on POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports - Updated the ApprovalRequestResponse type to optionally include resourceKind - Removed the beta tag from the following endpoints - POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports - GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID} - POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports - GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} - Make environments optional on : - GET /api/v2/flags/{projectKey} (List flags) - POST /api/v2/flags/{projectKey} (Create flag) - GET /api/v2/flags/{projectKey}/{featureFlagKey} (Get flag) - PATCH /api/v2/flags/{projectKey}/{featureFlagKey} (Patch flag) - POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy (Copy flag) - Added a list of valid values to the Import type returned by the GET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID} endpoint ## [17.1.0] - 2024-12-13 ### Added - Added a roleAttributes field to the POST /api/v2/teams endpoint (Create team) - Updated the request body type on PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Added new endpoints for working with integration configurations: - POST /api/v2/integration-configurations/keys/{integrationKey} (Create integration configuration) - GET /api/v2/integration-configurations/keys/{integrationKey} (Get all configurations for the integration) - GET /api/v2/integration-configurations/{integrationConfigurationId} (Get an integration configuration) - PATCH /api/v2/integration-configurations/{integrationConfigurationId} (Update integration configuration) - DELETE /api/v2/integration-configurations/{integrationConfigurationId} (Delete integration configuration) - Added the new endpoint PATCH /api/v2/approval-requests/{id} - Added a new endpoint in beta PUT /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Expose roleAttributes on the Team type - Expose totalCount in paginated roles API response ### Removed - Removed the unused bakeTimeDurationMs field from endpoints that return release and release pipeline details. These endpoints are currently in beta. - Removed the beta endpoint PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} ### Changed - Updated environment in the following beta endpoints to no longer be required, in order to account for deleted environments: - GET /api/v2/flags/{projectKey}/{flagKey}/release - PATCH /api/v2/flags/{projectKey}/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release - PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} - GET /api/v2/projects/{projectKey}/release-pipelines - POST /api/v2/projects/{projectKey}/release-pipelines - GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} - Renamed the /api/v2/integration-capabilities/big-segment-store endpoints to use the Persistent store integrations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/big-segment-store (List all big segment store integrations) - POST /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey} (Create big segment store integration) - GET /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Get big segment store integration by ID) - PATCH /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Update big segment store integration) - DELETE /api/v2/integration-capabilities/big-segment-store/{projectKey}/{environmentKey}/{integrationKey}/{integrationId} (Delete big segment store integration) - Renamed the /api/v2/integration-capabilities/flag-import endpoints to use the Flag import configurations (beta) tag. Previously they used the Integrations (beta) tag. If you use a generated client library, the package names have changed for the following endpoints: - GET /api/v2/integration-capabilities/flag-import (List all flag import configurations) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey} (Create a flag import configuration) - GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Get a single flag import configuration) - PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Update a flag import configuration) - DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId} (Delete a flag import configuration) - POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger (Trigger a single flag import run) - Updated the operation id and summary field definitions for the PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} endpoint - Updated items in /api/v2/roles response body to be required - Updated items in /api/v2/teams response body to be required - Added the property resourceApprovalSettings in the environment type - Updated instructions[].value property in the PATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey} endpoint to be a 64 bit integer ## [17.0.0] - 2024-10-15 ### Added - Added filter query parameter to GET /api/v2/metrics/{projectKey} (List metrics) - Added expand query parameter to GET /api/v2/members/{id} (Get member - Added expand query parameter to GET /api/v2/members (List member) - Added expand query parameter to PATCH /api/v2/members/{id} (Patch member) - Added expand query parameter to POST /api/v2/members (Create member) - Updated MemberRep to include RoleAttributes - Updated MetricInGroupRep and MetricV2Rep to both contain the metric's 'unitAggregationType- Updated thekindfield inDependentMetricOrMetricGroupRepto allow enum valuestandard, used for metric groups - Added latestCommitTimefield to the response ofGET /api/v2/code-refs/statistics/{projectKey}(Get code references statistics for flags) - Added optionalstatisticalMethodologyfield to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) - AddedstatisticalMethodologyfield to the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) - AddedautoApplyApprovedChangesfield to environment approval settings on project, environment, and approval request responses. - Addedtotal_countfield to the response ofGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts- Addedlinksfield to the response ofGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts- Addedlimitandoffsetquery parameters toGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts- Added theGET /api/v2/caller-identityendpoint to aid in secret scanning integrations - Updated theGET /api/v2/flags/{projectKey}/{flagKey}/releaseto include the property_idin the audience response - Added the following endpoints in beta for Release Automation: -DELETE /api/v2/flags/{projectKey}/{flagKey}/release -PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release -PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId} -GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases- Added optionalholdoutIdfield to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) - AddedholdoutIdfield to the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) - UpdatedGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName}to accept a limit param. - Added optionalprojectKey/environmentKeyto the query params of beta endpoints: -GET /api/v2/usage/service-connections -GET /api/v2/usage/experimentation-units -GET /api/v2/usage/experimentation-keys -GET /api/v2/usage/data-export-events- AddedenvironmentKeyfield to the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) - AddedPOST /api/v2/auditlogto support large policy statement lists (that would not otherwise fit in the URL) - Updated 200 response type forPUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}- UpdatedFeatureFlagStatusto use an enum for itsname- UpdatedPATCH /api/v2/projects/{projectKey}/flags/{flagKey}to include theignoreConflictsquery parameter - Addedvariancefield for each relative difference in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint - AddedvarianceReductionfield for each relative difference in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint - Added endpoints for managing experiment layers: - Create a new layer:POST /api/v2/projects/{projectKey}/layers - Update a layer:PATCH /api/v2/projects/{projectKey}/layers/{layerKey} - Get layers:GET /api/v2/projects/{projectKey}/layers- Added endpoints for managing holdouts: - Create a new holdout:POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey} - Update a holdout:PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey} - Get a holdout by id:GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId} - Get a holdout by key:GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}- AddedtotalCountfield to the response body ofGET /api/v2/metrics/{projectKey}(list metrics) - Added pagination toGET /api/v2/projects/{projectKey}/metric-groups(list metric groups) - Addedlimitandoffsetquery params - AddedtotalCountfield to the response body - Added optionalattributesfield to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(create experiment) andPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations(create iteration) - Addedversionfield to the response bodies of: -GET /api/v2/members(Get members) -GET /api/v2/members/{id}(Get member) -PATCH /api/v2/members/{id}(Patch member) -POST /api/v2/members(Create member) -POST /members/{id}/teams(Add member to teams) - Added optionalinitialPrerequisitesfield to request body ofPOST /api/v2/flags/{projectKey}endpoint (Create Flag). - AddedeventValuesSumfield for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint - Added new endpoints for working with flag import configurations: -POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}(Create flag import configuration) -GET /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}(Get flag import configuration) -GET /api/v2/integration-capabilities/flag-import(List all flag import configurations) -PATCH /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}(Update flag import configuration) -POST /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}/trigger(Trigger a flag import run) -DELETE /api/v2/integration-capabilities/flag-import/{projectKey}/{integrationKey}/{integrationId}(Delete flag import configuration) - Addedmodel, bayesianNormal, and bayesianBetafields for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint - Added optionalmethodologyfield to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) - Addedmethodologyfield to the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) - Addedcorrelation, sdRatio, and covariateImbalancefields for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint - Added optionalnamingConventionfield to the request body ofPOST /api/v2/projects(Create project) - Added new endpoint for updating an approval request:PATCH /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}(Update approval request) - Added optionalqueryfield to thefilterparam onGET /api/v2/projects/{projectKey}/metric-groupsto search against the metric group name and key - Added documentation for thefilterparam onGET /api/v2/projects/{projectKey}/metric-groups- Addedlimit, offset, and asOfquery parameters to theGET /api/v2/tags(List tags) endpoint - Added optionallimitfield toGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes- Updated thedistributionfield in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/resultsendpoint to always usenumberparameters ### Removed - Removed theisDirtyfield from theHoldoutresponses from the following endpoints: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId} -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}- RemovedstatisticalMethodologyfield from the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) - RemovedstatisticalMethodologyfield from the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create experiment) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Get experiments) ### Changed - Updated the following beta endpoints to include fields specific to Release Automation: -GET /api/v2/flags/{projectKey}/{flagKey}/release -PATCH /api/v2/flags/{projectKey}/{flagKey}/release -GET /api/v2/projects/{projectKey}/release-pipelines - Added support for filtering release pipelines byenvkey -POST /api/v2/projects/{projectKey}/release-pipelines -GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey} -PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}- Updatedpurposeenum onFlagPostinput object to includeholdout- Deprecated thecomparequery parameter in theGET /api/v2/flags/{projectKey}(List feature flags) endpoint - Updateddeprecatedas optional on the following endpoints: -GET /api/v2/flags/{projectKey} -POST /api/v2/flags/{projectKey} -GET /api/v2/flags/{projectKey}/{featureFlagKey} -PATCH /api/v2/flags/{projectKey}/{featureFlagKey} -POST /api/v2/flags/{projectKey}/{featureFlagKey}/copy- Updateddefaultas optional onPUT /api/v2/projects/{projectKey}/experimentation-settings- UpdatedtotalCountas optional onGET /api/v2/segments/{projectKey}/{environmentKey}- Updatevalueas optional onPatchOperationsince it is only required for certain JSON Patch operations - UpdateExperiments (beta)tag toExperiments- Updated iterations to includeattributesfield in the response bodies of -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/ -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey} -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey} -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/{holdoutKey}- RenamedPUT /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}asputFlagFollower- RenamedDELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}asdeleteFlagFollower- Updated the types of query parameters in theGET /api/v2/tags(List tags) endpoint ### Bug Fixes - Updated OpenAPI specification to include missingsort, limitandoffsetquery params on theGET /api/v2/metrics/{projectKey}(list metrics) endpoint - Fixed incorrectselfandnextlinks sometimes returned by theGET /api/v2/metrics/{projectKey}(list metrics) endpoint ## [16.1.1] - 2024-05-16 No significant changes ## [16.1.0] - 2024-05-16 ### Added - Added optionalnotInExperimentVariationIdfield toflagsinsideiterationin the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create Experiment) - Added optionalnotInExperimentVariationIdfield inflagsin the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations(Create Iteration) - AddednotInExperimentVariationIdfield to theflagsobject in the response bodies of: -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments(Create Experiment) -POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations(Create Iteration) -PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch Experiment) -GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Get Experiment) - Added HTTP 409 as a possible response status code forPATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}(Patch Experiment) ### Removed ### Changed ## [16.0.0] - 2024-04-15 ### Added - AddedtotalCountfield to response ofGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows- Addedlimitandoffsetquery params togetWorkflowsandgetCustomRolesendpoints ### Removed - Removed thefollowerId, hasDataExport, status, contextKindTargeted, and segmentTargetedfilters for thegetFeatureFlagsendpoint - Removed theprojectsandrolesoptions for theexpandquery parameter in thegetTeamsendpoint ### Changed ## [15.1.0] - 2024-04-03 ### Added - Added ReleaseAudience type - Added Usage endpoints -GET /api/v2/usage/service-connections -GET /api/v2/usage/data-export-events ### Removed ### Changed - AddedmaintainerIdandmaintainerTeamKeyoptions to flags create endpoint - UpdatedReleasePhaseto have type[]ReleaseAudienceinstead of[]AudienceforAudiencesfield - UpdatedGET /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issuesto remove it from beta ## [15.0.0] - 2024-03-13 ### Added - AddeddeprecatedanddeprecatedDateto the rep returned by the flags endpoints - Added an optionaldescriptionfield for a segment rule - AddedIntegrations (beta)endpoints for working with big segment persistent store integrations - AddedenvironmentKeyto dependent experiment rep - AddedlastModifiedto theunboundedobject returned by Segment APIs - Addedresultsfield toGET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results, deprecating treatmentResults- Addedcriticalto Environment object andPOST /api/v2/projects/{projectKey}/environmentsendpoint request body. - Addedexpandquery parameter toGET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/resultswith support for expandingtraffic- Added pagination parameters limit and offset to /api/v2/tokens - Added missing response information toPATCH /api/v2/flags/{projectKey}/{flagKey}/release- Added 4xx response info toGET /api/v2, GET /api/v2/openapi.json, and GET /api/v2/public-ip-list- Addedkeyto the rep returned by flag defaults endpoints - Addedtypeto code references statistics reps - Addedstandardas a metric group kind - AddedprimarySingleMetric, primaryFunnel, and metricstoIterationRep, deprecating primaryMetricandsecondaryMetric- AddedprimarySingleMetricKeyandprimaryFunnelKeytoIterationInput, deprecating primaryinMetricInput- Added_versionIdfield to the metric rep returned by metric and experimentation endpoints - Added_accessobject to the project rep - Added beta engineering insights endpoints - Addedtypefield to the experimentAllocation rep within flag rollouts ### Removed - Removed components schemas that were unused by any paths or operations - Removed the endpoint to reset experiment results - Removed the endpoint to create an application - Removed the endpoint to create an application version ### Changed - Updated definition of post delete approval request to include previously ommited error codes 405 and 409 - Markedkeyandnamerequired inMaintainerTeamto match API behavior - Addedfilterto/api/v2/projects/{projectKey}/release-pipelines- Added pagination parameterslimitandoffsetto/api/v2/projects/{projectKey}/release-pipelines- Renamed experimentation settings endpoints and reps to randomization settings, the fields and api's remain the same. - MarkednameInGroupas optional inMetricInGroupRepif and only if the group isn't afunnel. ## [14.0.0] - 2023-11-15 ### Added - Added Application and Application version endpoints, in beta - Added unitOfAnalysisfield to the metric listing rep returned by get all metrics endpoint - AddedlastSeenfield to the metric listing rep returned by get all metrics endpoint - Added_accessobject to the release pipeline rep returned by several endpoints - Added_linksfield to the team summary object returned by several endpoints - Added beta endpoint for getting experimentation units usage - AddediterationIdquery string parameter to/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results- Added pagination parameterslimitandoffsetto/api/v2/segments/{projKey}/{envKey}- AddedlastModifiedDatefield to response ofGET /api/v2/segments/{projectKey}/{environmentKey}- Addedsortto/api/v2/segments/{projKey}/{envKey}- Addedfilterto/api/v2/segments/{projKey}/{envKey}- Added_idfield to the expandedprojectinformation inTeamsendpoints - Addedpurposefield to theFlagPostinput object - AddedmigrationSettingsfield to theFlagPostinput object - Addedarchivedfield toGET /api/v2/projects/{projectKey}/context-kindsandPUT /api/v2/projects/{projectKey}/context-kinds/{key}- Markeditemsrequired inFlagFollowersGetRepto match API behavior - Added_flagCountfield toGET /api/v2/segments/{projectKey}/{environmentKey}- AddedtotalEvaluationsfield toGET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey}- Added Release pipelines and Releases endpoints, in beta - Added links in environment representations - Updatecodeandmessageon error reps to be required to match API behavior - Addednamefield toPhaseInfoforGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases- AddedunitAggregationType, analysisType, and eventDefaultfields toGET /api/v2/metrics/{projectKey}, GET /api/v2/metrics/{projectKey}/{metricKey}, POST /api/v2/metrics/{projectKey}, and PATCH /api/v2/metrics/{projectKey}/{metricKey}- Markeditemsas required inEnvironmentCollectionRepto match API behavior - Markedcolorandnameas required inEnvironmentSummaryRepto match API behavior - Added@failure 404with a value ofMember not foundtoPOST /api/v2/members/{id}/teams- Added beta endpoint to retrieve migration safety issues when updating a migration flag - AddedmigrationSettingsexpand parameter toGET /api/v2/flags/{projectKey}- AddedmigrationSettingsexpand parameter toGET /api/v2/flags/{projectKey}/{featureFlagKey}- Addedlimitandoffsetquery params toGET /projects/{projKey}/release-pipelines/{pipelineKey}/releases- Added beta endpoints to create, delete, and list metric groups - Markeditemsas required onExperimentCollectionRepto match API behavior - AddedisGroupandmetricsfields toDependentMetricOrMetricGroupRep- AddedisGroupfield toMetricInput- AddedrandomizationUnitsfield toMetricInGroupRep- AddedmetricGroupsandmetricGroupCountexpand parameters to thegetMetricendpoint ### Removed ### Changed - MovedPATCH /projects/{projKey}/release-pipelines/{pipelineKey}out of hidden docs - Setdeprecatedproperty on legacy experimentation operation which has already been deprecated - GET/api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}- Setdeprecatedonoffsetparameter which has already been deprecated - GET/api/v2/user-search/{projectKey}- Setdeprecatedon flag-related schema properties that have already been deprecated - Moved OAuth Client APIs out of beta - Updated the response body ofReviewOutputto optionally returnserviceTokenId, omitted when approval reviewer was a member - Updated the response body of ReviewResponseto optionally returnserviceTokenId, omitted when approval reviewer was a member - Updated the response body of FlagConfigApprovalRequestResponseto optionally returnappliedByServiceTokenId, omitted when a member applies an approval - Set deprecatedproperty on legacy users endpoints, which are replaced by contexts endpoints - DELETE/api/v2/users/{projectKey}/{environmentKey}/{userKey} - GET/api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} - GET/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags - GET/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} - GET/api/v2/users/{projectKey}/{environmentKey} - GET/api/v2/users/{projectKey}/{environmentKey}/{userKey} - GET/api/v2/user-attributes/{projectKey}/{environmentKey} - GET/api/v2/user-search/{projectKey}/{environmentKey} - PATCH/api/v2/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} - PUT/api/v2/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}- Moved Approvals APIs out of beta - Moved Workflow APIs out of beta - Moved Workflow template APIs out of beta - Updated the response body of theMemberstruct to clarify that in thepermissionGrants, only one of actionsoractionSetis required - Updated type ofPrimaryMetricinIterationRep- UpdatedmaintainerIdto be an optional parameter when creating a new experiment - UpdatedcontextTargetsfield for flags endpoints to be required - RenamedmetricWrappertoMetricWrapper- Updated type ofEffectin custom roles tostring- Added theexpandquery parameter for thegetExperimentendpoint - GET/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}- Updated description and unhidarchivedfield onGET /api/v2/projects/{projectKey}/context-kindsandPUT /api/v2/projects/{projectKey}/context-kinds/{key}- Updated description forhideInTargetingfield onGET /api/v2/projects/{projectKey}/context-kindsandPUT /api/v2/projects/{projectKey}/context-kinds/{key}- Moved Context Kind APIs out of beta - Updated response body of GET/api/v2/flags/{projectKey}/{flagKey}/releaseand PATCH/api/v2/flags/{projectKey}/{flagKey}/releaseto includeMemberSummaryandTokenSummaryin each phase'scompletedByfield instead of having flat values. - RenamedactiveReleasesandcompletedReleasestoactiveCountandtotalCountforGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases- Updated the response body ofFeatureFlagandFeatureFlagConfigto returnmigrationSettingswhen callingPATCH /api/v2/flags/{projectKey}/{featureFlagKey}- Setdeprecatedproperty onarchivedquery param forGET /api/v2/flags/{projectKey}- RenamedDependentMetricReptoDependentMetricOrMetricGroupRep- Updated thekindfield inDependentMetricOrMetricGroupRepto allow enum valuefunnel, used for metric groups - Renamed MetricWrappertoMetricInGroupRep- Get metricmetricGroupsandmetricGroupCountfields are expandable, omitted by default ### Bug Fixes -RootResponseschema was incorrect ## [13.0.0] - 2023-04-19 ### Added ### Removed ### Changed - Moved Contexts APIs out of beta ### Bug Fixes ## [12.1.0] - 2023-04-12 ### Added - Added beta endpoint for server connection minutes usage - AddedcustomRolesexpand parameter toGET /api/v2/members- Added 409 return code information for reset environment keys endpoints - Added new beta endpoints for approvals - Updated response bodies for beta approval endpoints - AddedcontextKindTargetedfilter parameter toGET /api/v2/flags/{projectKey}- AddedcontextKindsEvaluatedfilter parameter toGET /api/v2/flags/{projectKey}- Addedevaluationexpand parameter toGET /api/v2/flags/{projectKey}- Addedevaluationexpand parameter toGET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} ### Removed ### Changed - Updated note for parammemberIdin follow flag endpointsputFlagFollowersanddeleteFlagFollowersto reflect the limitation of Reader roles. - Updated the response body ofExpandableApprovalRequestResponseto optionally returnenvironmentsinstead ofenvironmentwhich is only used in beta APIs - Corrected documentation of semantic patch instructions for operation IDspatchExpiringFlagsForUser, patchExpiringTargetsForSegment,patchExpiringUserTargets, patchExpiringTargets. ## [12.0.0] - 2023-02-27 ### Added - Added "Contexts (beta)" and "Context settings (beta)" categories - Added StopDatetoExecutionOutputobject - Added support for sorting via query parameter in theGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows - Added beta endpoint for updating flag settings for a context - Added endpoints for retrieving segment membership of a non-user context and of a context instance - Added beta endpoint for updating individual targets on big segments with non-usercontext kind - Added beta endpoint for getting a list of approval requests - Added beta endpoint for getting a single approval request - Addedresultsfield to the experiment metric results response for contexts that have data slicing enabled - AddedresourceIdandapprovalSettingsfields to the responses forgetApprovalRequestandgetApprovalRequests- Addedstatusquery parameters to thegetWorkflowsbeta endpoint - AddedexperimentalPropertiesfield to experiment create post body - AddedrandomizationUnitto - theIterationInputobject - the responses forgetExperiment, getExperiments, and createIteration- AddedrandomizationUnitsto - theMetricPostobject - the responses forgetMetricandgetMetrics- Added beta endpoint for retrieving experimentation settings for a given project - Added beta endpoint for updating experimentation settings for a given project - Added beta endpoint getting experimentation keys usage ### Removed ### Changed - Updated title ofgetAuditLogEntriesto reflect that audit logs aren't specific to feature flags - Updated operation IDpostApprovalRequesttopostApprovalRequestForFlagto reflect that it's flag specific. The title has also been updated to reflect this. - Updated operation IDpostApprovalRequestReviewtopostApprovalRequestReviewForFlagto reflect that it's flag specific. The title has also been updated to reflect this. - Updated operation IDpostApprovalRequestApplyRequesttopostApprovalRequestApplyForFlagto reflect that it's flag specific. The title has also been updated to reflect this. - Updated operation IDdeleteApprovalRequesttodeleteApprovalRequestForFlagto reflect that it's flag specific. The title has also been updated to reflect this. - Updated to new syntax for filter query param in beta endpointgetApprovalRequests. Support for the old syntax is being dropped. See documentation for new syntax. - Updated type of LinksinFlagConfigApprovalRequestResponse ### Bug Fixes - FixingpostWorkflowbeta endpoint -nameisrequired(previously incorrectly marked as optional) -descriptionisoptional(previously incorrectly marked as required) ## [11.0.0] - 2022-11-21 ### Added - Added beta Workflow templates endpoints - added structs for Flag Reuse to be expanded upon later - AddedtargetingRuleDescriptionto experiment iteration flag response - AddedtargetingRuleClausesto experiment iteration flag response - AddedprobabilityOfMismatchto experiment result response - AddedarchivedDatefield to experiment response, omitted when experiment is not archived - AddedarchivedDatefield to expanded experiment for the Get metric endpoint, omitted when experiment is not archived - AddedlifecycleStateparameter to Get experiments to query by archived and/or active experiments - Added_idpSyncedparameter toTeamobject - Added beta endpoints for flag defaults - Added beta endpoint for bulk editing members - Added beta endpoint for bulk editing teams - AddedmaintainerTeamKeyand_maintainerTeamto the flag rep for teams as flag maintainers - Add beta endpoints for Approval Requests - Added "Contexts (beta)" tag - AddedcontextKindto flag rule clause response - AddedcontextKindto flag rule rollout response - AddedcontextTargetsto flag config response - AddedunboundedContextKindto segment request body and response - AddedvaluesandcontextKindto theSegmentTargetresponse - AddedincludedContextsandexcludedContextsto the segment response - AddedrolloutContextKindto the segment rule response ### Removed ### Changed - Updated beta create workflow endpoint to allow for creating a workflow from a template - In the Experiments endpoints, updated the existingkind field in the metric types to only include the allowed enum values (pageview, click, custom) - Get metric experimentsfield is expandable, omitted by default - Get metricexperimentCountfield is expandable, omitted by default - Get metric listexperimentCountfield is expandable, omitted by default - RenamedExpiringUserTargetErrortoExpiringTargetErrorto prepare for expiring context targets - New code reference repositories will set thedefaultBranchtomainif you do not specify a value during creation - In repository endpoints,gitlabis now a supportedrepoType- In the flag creation endpoint, updated endpoint to replace applicablenullvalues with project-level flag defaults - RenamedgetApprovalsandgetApprovalendpoints togetApprovalsForFlagandgetApprovalForFlagrespectively ### Bug Fixes - Updated OpenAPI specification to include the missingsortquery param onGET /projects- UpdatedResourceIdentifierfrom an empty Object to a string type - UpdatedUUIDto be a string with formatuuid ## [10.1.0] - 2022-10-11 ### Added - Added optionalteamKeystoNewMemberForm ## [10.0.0] - 2022-07-11 ### Added - Support for federal serverhttps://app.launchdarkly.us` - Teams API out of beta - New beta OAuth2 Clients API - New follow flags API - Added optional ruleClause to ParameterDefault object - Added optional oauthProviders to Member object - Added optional templateKey to CustomWorkflowInputRep object - Added optional notifyTeamKeys parameter to - create approval - create approval request to copy flag configurations across environments - create workflow ### Changed - Changed StatementRep to Statement - Using version 6.0.0 of OpenAPI generator - Changes to beta experimentation API - Renamed StatementRep to Statement - List projects has a default limit of 20, added support for filter and sort - List projects environment field is expandable, omitted by default - Get project environment field is expandable, omitted by default - Changed notifyMemberIds from required to optional for create approval and flag config copy approval requests - In the Approvals endpoints, updated existing fields in response types to only include the allowed enum values: - reviewStatus and status in FlagConfigApprovalRequestResponse - kind in ReviewResponse ### Bug Fixes - Removed unintentionally exposed optional variationJsonSchema from FeatureFlagBody - Added missing variations to FlagSummary object - Removed required attribute from fields on the GET /api/v2/flags/{projectKey} response that are only shown when the request contains ?summary=false ## [9.0.1] - 2022-04-29 ### Changed - Changes to Experiments (beta) endpoints ## [9.0.0] - 2022-04-12 ### Added - Added Experiments (beta) endpoints - GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments - Added optional reason to ExecutionOutputRep - Added executeConditionsInSequence to StageInputRep - Added required fileCount to StatisticRep ### Changed - Changes to Experiments (beta) endpoints ## [8.0.0] - 2022-03-11 ### Added - Added Tags endpoint - GET /api/v2/tags - Added Flag links (beta) endpoints - GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} - POST /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} ### Removed - Removed derived property from User object ### Changed - Updates to our Teams (beta) endpoint - Updates to our Worfklows (beta) endpoint ### Bug Fixes - Added 409 conflict response to DELETE /api/v2/flags/{projectKey}/{featureFlagKey}