Releases: launchdarkly/api-client-python
Releases · launchdarkly/api-client-python
v17.2.0
Added
- Added a new
maintainerId
field to the input request body of thePOST /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 toGET /api/v2/roles
andGET /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 andexpand
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 thePATCH /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
andcostPerInputToken
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 endpointPOST /api/v2/metrics/{projectKey}
Changed
- Updated the Data Export destination endpoints to include a new destination
kind
- Expose
waitOnApprovals
request parameter onPOST /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 theGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}
endpoint
v17.1.0
Added
- Added a
roleAttributes
field to thePOST /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 thePersistent store integrations (beta)
tag. Previously they used theIntegrations (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 theFlag import configurations (beta)
tag. Previously they used theIntegrations (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 thePATCH /api/v2/segments/{projectKey}/{segmentKey}/expiring-targets/{environmentKey}
endpoint to be a 64 bit integer
17.0.0
Added
- Added
filter
query parameter toGET /api/v2/metrics/{projectKey}
(List metrics) - Added
expand
query parameter toGET /api/v2/members/{id}
(Get member - Added
expand
query parameter toGET /api/v2/members
(List member) - Added
expand
query parameter toPATCH /api/v2/members/{id}
(Patch member) - Added
expand
query parameter toPOST /api/v2/members
(Create member) - Updated
MemberRep
to includeRoleAttributes
- Updated
MetricInGroupRep
andMetricV2Rep
to both contain the metric's 'unitAggregationType` - Updated the
kind
field inDependentMetricOrMetricGroupRep
to allow enum valuestandard
, used for metric groups - Added
latestCommitTime
field to the response ofGET /api/v2/code-refs/statistics/{projectKey}
(Get code references statistics for flags) - Added optional
statisticalMethodology
field to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create experiment) - Added
statisticalMethodology
field 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)
- Added
autoApplyApprovedChanges
field to environment approval settings on project, environment, and approval request responses. - Added
total_count
field to the response ofGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
- Added
links
field to the response ofGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
- Added
limit
andoffset
query parameters toGET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
- Added the
GET /api/v2/caller-identity
endpoint to aid in secret scanning integrations - Updated the
GET /api/v2/flags/{projectKey}/{flagKey}/release
to include the property_id
in 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 optional
holdoutId
field to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create experiment) - Added
holdoutId
field 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)- Updated
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes/{attributeName}
to accept a limit param.
- Added optional
projectKey
/environmentKey
to 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
- Added
environmentKey
field 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)
- Added
POST /api/v2/auditlog
to support large policy statement lists (that would not otherwise fit in the URL) - Updated 200 response type for
PUT /api/v2/projects/{projectKey}/flags/{flagKey}/release/phases/{phaseId}
- Updated
FeatureFlagStatus
to use an enum for itsname
- Updated
PATCH /api/v2/projects/{projectKey}/flags/{flagKey}
to include theignoreConflicts
query parameter - Added
variance
field for each relative difference in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint - Added
varianceReduction
field for each relative difference in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint - 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
- Create a new layer:
- 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}
- Create a new holdout:
- Added
totalCount
field to the response body ofGET /api/v2/metrics/{projectKey}
(list metrics) - Added pagination to
GET /api/v2/projects/{projectKey}/metric-groups
(list metric groups)- Added
limit
andoffset
query params - Added
totalCount
field to the response body
- Added
- Added optional
attributes
field 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) - Added
version
field 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 optional
initialPrerequisites
field to request body ofPOST /api/v2/flags/{projectKey}
endpoint (Create Flag). - Added
eventValuesSum
field for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint - 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)
- Added
model
,bayesianNormal
, andbayesianBeta
fields for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint - Added optional
methodology
field to the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create experiment) - Added
methodology
field 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)
- Added
correlation
,sdRatio
, andcovariateImbalance
fields for each treatment result in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint - Added optional
namingConvention
field 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 optional
query
field to thefilter
param onGET /api/v2/projects/{projectKey}/metric-groups
to search against the metric group name and key - Added documentation for the
filter
param onGET /api/v2/projects/{projectKey}/metric-groups
- Added
limit
,offset
, andasOf
query parameters to theGET /api/v2/tags
(List tags) endpoint - Added optional
limit
field toGET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes
- Updated the
distribution
field in theGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
endpoint to always usenumber
parameters - Added new endpoints for working with integration configurations:
POST /api/v2/integration-configurations/keys/{integrationKey}
(Create integration configuration)- `GET /api/v2/integrati...
16.1.1
No significant changes.
Full Changelog: 16.1.0...16.1.1
16.1.0
[16.1.0] - 2024-05-16
Added
- Added optional
notInExperimentVariationId
field toflags
insideiteration
in the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
(Create Experiment) - Added optional
notInExperimentVariationId
field inflags
in the request body ofPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations
(Create Iteration) - Added
notInExperimentVariationId
field to theflags
object 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 for
PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
(Patch Experiment)
16.0.0
Added
- Added
totalCount
field to response ofGET /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/workflows
- Added
limit
andoffset
query params togetWorkflows
andgetCustomRoles
endpoints
Removed
- Removed the
followerId
,hasDataExport
,status
,contextKindTargeted
, andsegmentTargeted
filters for thegetFeatureFlags
endpoint - Removed the
projects
androles
options for theexpand
query parameter in thegetTeams
endpoint
15.0.0
Added
- Added
deprecated
anddeprecatedDate
to the rep returned by the flags endpoints - Added an optional
description
field for a segment rule - Added
Integrations (beta)
endpoints for working with big segment persistent store integrations - Added
environmentKey
to dependent experiment rep - Added
lastModified
to theunbounded
object returned by Segment APIs - Added
results
field toGET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results
, deprecatingtreatmentResults
- Added
critical
to Environment object andPOST /api/v2/projects/{projectKey}/environments
endpoint request body. - Added
expand
query parameter toGET /projects/{projKey}/environments/{envKey}/experiments/{experimentKey}/metrics/{metricKey}/results
with support for expandingtraffic
- Added pagination parameters limit and offset to /api/v2/tokens
- Added missing response information to
PATCH /api/v2/flags/{projectKey}/{flagKey}/release
- Added 4xx response info to
GET /api/v2
,GET /api/v2/openapi.json
, andGET /api/v2/public-ip-list
- Added
key
to the rep returned by flag defaults endpoints - Added
type
to code references statistics reps - Added
standard
as a metric group kind - Added
primarySingleMetric
,primaryFunnel
, andmetrics
toIterationRep
, deprecatingprimaryMetric
andsecondaryMetric
- Added
primarySingleMetricKey
andprimaryFunnelKey
toIterationInput
, deprecatingprimary
inMetricInput
- Added
_versionId
field to the metric rep returned by metric and experimentation endpoints - Added beta engineering insights endpoints
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
- Marked
key
andname
required inMaintainerTeam
to match API behavior - Added
filter
to/api/v2/projects/{projectKey}/release-pipelines
- Added pagination parameters
limit
andoffset
to/api/v2/projects/{projectKey}/release-pipelines
- Renamed experimentation settings endpoints and reps to randomization settings, the fields and api's remain the same.
- Marked
nameInGroup
as optional inMetricInGroupRep
if and only if the group isn't afunnel
.
14.0.0
Added
- Added Application and Application version endpoints, in beta
- Added
unitOfAnalysis
field to the metric listing rep returned by get all metrics endpoint - Added
lastSeen
field to the metric listing rep returned by get all metrics endpoint - Added
_access
object to the release pipeline rep returned by several endpoints - Added
_links
field to the team summary object returned by several endpoints - Added beta endpoint for getting experimentation units usage
- Added
iterationId
query string parameter to/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
- Added pagination parameters
limit
andoffset
to/api/v2/segments/{projKey}/{envKey}
- Added
lastModifiedDate
field to response ofGET /api/v2/segments/{projectKey}/{environmentKey}
- Added
sort
to/api/v2/segments/{projKey}/{envKey}
- Added
filter
to/api/v2/segments/{projKey}/{envKey}
- Added
_id
field to the expandedproject
information inTeams
endpoints - Added
purpose
field to theFlagPost
input object - Added
migrationSettings
field to theFlagPost
input object - Added
archived
field toGET /api/v2/projects/{projectKey}/context-kinds
andPUT /api/v2/projects/{projectKey}/context-kinds/{key}
- Marked
items
required inFlagFollowersGetRep
to match API behavior - Added
_flagCount
field toGET /api/v2/segments/{projectKey}/{environmentKey}
- Added
totalEvaluations
field toGET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey}
- Added Release pipelines and Releases endpoints, in beta
- Added links in environment representations
- Update
code
andmessage
on error reps to be required to match API behavior - Added
name
field toPhaseInfo
forGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
- Added
unitAggregationType
,analysisType
, andeventDefault
fields toGET /api/v2/metrics/{projectKey}
,GET /api/v2/metrics/{projectKey}/{metricKey}
,POST /api/v2/metrics/{projectKey}
, andPATCH /api/v2/metrics/{projectKey}/{metricKey}
- Marked
items
as required inEnvironmentCollectionRep
to match API behavior - Marked
color
andname
as required inEnvironmentSummaryRep
to match API behavior - Added
@Failure 404
with a value ofMember not found
toPOST /api/v2/members/{id}/teams
- Added beta endpoint to retrieve migration safety issues when updating a migration flag
- Added
migrationSettings
expand parameter toGET /api/v2/flags/{projectKey}
- Added
migrationSettings
expand parameter toGET /api/v2/flags/{projectKey}/{featureFlagKey}
- Added
limit
andoffset
query params toGET /projects/{projKey}/release-pipelines/{pipelineKey}/releases
- Added beta endpoints to create, delete, and list metric groups
- Marked
items
as required onExperimentCollectionRep
to match API behavior - Added
isGroup
andmetrics
fields toDependentMetricOrMetricGroupRep
- Added
isGroup
field toMetricInput
- Added
randomizationUnits
field toMetricInGroupRep
- Added
metricGroups
andmetricGroupCount
expand parameters to thegetMetric
endpoint
Changed
- Moved
PATCH /projects/{projKey}/release-pipelines/{pipelineKey}
out of hidden docs - Set
deprecated
property on legacy experimentation operation which has already been deprecated- GET
/api/v2/flags/{projectKey}/{featureFlagKey}/experiments/{environmentKey}/{metricKey}
- GET
- Set
deprecated
onoffset
parameter which has already been deprecated- GET
/api/v2/user-search/{projectKey}
- GET
- Set
deprecated
on flag-related schema properties that have already been deprecated - Moved OAuth Client APIs out of beta
- Updated the response body of
ReviewOutput
to optionally returnserviceTokenId
, omitted when approval reviewer was a member - Updated the response body of
ReviewResponse
to optionally returnserviceTokenId
, omitted when approval reviewer was a member - Updated the response body of
FlagConfigApprovalRequestResponse
to optionally returnappliedByServiceTokenId
, omitted when a member applies an approval - Set
deprecated
property 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}
- DELETE
- Moved Approvals APIs out of beta
- Moved Workflow APIs out of beta
- Moved Workflow template APIs out of beta
- Updated the response body of the
Member
struct to clarify that in thepermissionGrants
, only one ofactions
oractionSet
is required - Updated type of
PrimaryMetric
inIterationRep
- Updated
maintainerId
to be an optional parameter when creating a new experiment - Updated
contextTargets
field for flags endpoints to be required - Renamed
metricWrapper
toMetricWrapper
- Updated type of
Effect
in custom roles tostring
- Added the
expand
query parameter for thegetExperiment
endpoint- GET
/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
- GET
- Updated description and unhid
archived
field onGET /api/v2/projects/{projectKey}/context-kinds
andPUT /api/v2/projects/{projectKey}/context-kinds/{key}
- Updated description for
hideInTargeting
field onGET /api/v2/projects/{projectKey}/context-kinds
andPUT /api/v2/projects/{projectKey}/context-kinds/{key}
- Moved Context Kind APIs out of beta
- Updated response body of GET
/api/v2/flags/{projectKey}/{flagKey}/release
and PATCH/api/v2/flags/{projectKey}/{flagKey}/release
to includeMemberSummary
andTokenSummary
in each phase'scompletedBy
field instead of having flat values. - Renamed
activeReleases
andcompletedReleases
toactiveCount
andtotalCount
forGET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
- Updated the response body of
FeatureFlag
andFeatureFlagConfig
to returnmigrationSettings
when callingPATCH /api/v2/flags/{projectKey}/{featureFlagKey}
- Set
deprecated
property onarchived
query param forGET /api/v2/flags/{projectKey}
- Renamed
DependentMetricRep
toDependentMetricOrMetricGroupRep
- Updated the
kind
field inDependentMetricOrMetricGroupRep
to allow enum valuefunnel
, used for metric groups - Renamed
MetricWrapper
toMetricInGroupRep
- Get metric
metricGroups
andmetricGroupCount
fields are expandable, omitted by default
Bug Fixes
RootResponse
schema was incorrect
13.0.0
12.1.0
[12.1.0] - 2023-04-12
Added
- Added beta endpoint for server connection minutes usage
- Added
customRoles
expand 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
- Added
contextKindTargeted
filter parameter toGET /api/v2/flags/{projectKey}
- Added
contextKindsEvaluated
filter parameter toGET /api/v2/flags/{projectKey}
- Added
evaluation
expand parameter toGET /api/v2/flags/{projectKey}
- Added
evaluation
expand parameter toGET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}
Removed
Changed
- Updated note for param
memberId
in follow flag endpointsputFlagFollowers
anddeleteFlagFollowers
to reflect the limitation of Reader roles. - Updated the response body of
ExpandableApprovalRequestResponse
to optionally returnenvironments
instead ofenvironment
which is only used in beta APIs