16.1.1

[16.1.1] - 2024-05-16

Fixed:

Typescript

• Updated Axios dependency to resolve CVE-2023-45857. launchdarkly/api-client-typescript#9

16.1.0

[16.1.0] - 2024-05-16

Added

• Added optional notInExperimentVariationId field to flags inside iteration in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create Experiment)
• Added optional notInExperimentVariationId field in flags in the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterations (Create Iteration)
• Added notInExperimentVariationId field to the flags 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)

Typescript

• Updated Axios dependency to resolve CVE-2023-45857. launchdarkly/api-client-typescript#9

Go

• Generate interfaces to make mocking easier in tests. #116

15.1.0

[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

Changed

• Added maintainerId and maintainerTeamKey options to flags create endpoint

• Updated ReleasePhase to have type []ReleaseAudience instead of []Audience for Audiences field

14.0.0

[14.0.0] - 2023-11-16

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 and offset to /api/v2/segments/{projKey}/{envKey}
• Added lastModifiedDate field to response of GET /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 expanded project information in Teams endpoints
• Added purpose field to the FlagPost input object
• Added migrationSettings field to the FlagPost input object
• Added archived field to GET /api/v2/projects/{projectKey}/context-kinds and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
• Marked items required in FlagFollowersGetRep to match API behavior
• Added _flagCount field to GET /api/v2/segments/{projectKey}/{environmentKey}
• Added totalEvaluations field to GET /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey}
• Added Release pipelines and Releases endpoints, in beta
  • Added links in environment representations
• Update code and message on error reps to be required to match API behavior
• Added name field to PhaseInfo for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
• Added unitAggregationType, analysisType, and eventDefault fields to GET /api/v2/metrics/{projectKey}, GET /api/v2/metrics/{projectKey}/{metricKey}, POST /api/v2/metrics/{projectKey}, and PATCH /api/v2/metrics/{projectKey}/{metricKey}
• Marked items as required in EnvironmentCollectionRep to match API behavior
• Marked color and name as required in EnvironmentSummaryRep to match API behavior
• Added @Failure 404 with a value of Member not found to POST /api/v2/members/{id}/teams
• Added beta endpoint to retrieve migration safety issues when updating a migration flag
• Added migrationSettings expand parameter to GET /api/v2/flags/{projectKey}
• Added migrationSettings expand parameter to GET /api/v2/flags/{projectKey}/{featureFlagKey}
• Added limit and offset query params to GET /projects/{projKey}/release-pipelines/{pipelineKey}/releases
• Added beta endpoints to create, delete, and list metric groups
• Marked items as required on ExperimentCollectionRep to match API behavior
• Added isGroup and metrics fields to DependentMetricOrMetricGroupRep
• Added isGroup field to MetricInput
• Added randomizationUnits field to MetricInGroupRep

Removed

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}
• Set deprecated on offset parameter which has already been deprecated
  • GET /api/v2/user-search/{projectKey}
• 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 return serviceTokenId, omitted when approval reviewer was a member
• Updated the response body of ReviewResponse to optionally return serviceTokenId, omitted when approval reviewer was a member
• Updated the response body of FlagConfigApprovalRequestResponse to optionally return appliedByServiceTokenId, 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}
• 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 the permissionGrants, only one of actions or actionSet is required
• Updated type of PrimaryMetric in IterationRep
• Updated maintainerId to be an optional parameter when creating a new experiment
• Updated contextTargets field for flags endpoints to be required
• Renamed metricWrapper to MetricWrapper
• Updated type of Effect in custom roles to string
• Added the expand query parameter for the getExperiment endpoint
  • GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}
• Updated description and unhid archived field on GET /api/v2/projects/{projectKey}/context-kinds and PUT /api/v2/projects/{projectKey}/context-kinds/{key}
• Updated description for hideInTargeting field on GET /api/v2/projects/{projectKey}/context-kinds and PUT /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 include MemberSummary and TokenSummary in each phase's completedBy field instead of having flat values.
• Renamed activeReleases and completedReleases to activeCount and totalCount for GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}/releases
• Updated the response body of FeatureFlag and FeatureFlagConfig to return migrationSettings when calling PATCH /api/v2/flags/{projectKey}/{featureFlagKey}
• Set deprecated property on archived query param for GET /api/v2/flags/{projectKey}
• Renamed DependentMetricRep to DependentMetricOrMetricGroupRep
• Updated the kind field in DependentMetricOrMetricGroupRep to allow enum value funnel, used for metric groups
• Renamed MetricWrapper to MetricInGroupRep

Bug Fixes

• RootResponse schema was incorrect

13.0.0

[13.0.0] - 2023-04-19

Added

Removed

Changed

• Moved Contexts APIs out of beta

12.1.0

[12.1.0] - 2023-04-12

Added

• Added beta endpoint for server connection minutes usage
• Added customRoles expand parameter to GET /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 to GET /api/v2/flags/{projectKey}
• Added contextKindsEvaluated filter parameter to GET /api/v2/flags/{projectKey}
• Added evaluation expand parameter to GET /api/v2/flags/{projectKey}
• Added evaluation expand parameter to GET /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}

Removed

Changed

• Updated note for param memberId in follow flag endpoints putFlagFollowers and deleteFlagFollowers to reflect the limitation of Reader roles.
• Updated the response body of ExpandableApprovalRequestResponse to optionally return environments instead of environment which is only used in beta APIs

12.0.0

[12.0.0] - 2023-02-27

Added

• Added "Contexts (beta)" and "Context settings (beta)" categories
• Added StopDate to ExecutionOutput object
• Added support for sorting via query parameter in the GET /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-user context kind
• Added beta endpoint for getting a list of approval requests
• Added beta endpoint for getting a single approval request
• Added results field to the experiment metric results response for contexts that have data slicing enabled
• Added resourceId and approvalSettings fields to the responses for getApprovalRequest and getApprovalRequests
• Added status query parameters to the getWorkflows beta endpoint
• Added beta endpoint for fetching client-side monthly context instance usage
• Added beta endpoint for fetching client-side connection minutes usage
• Added beta endpoint for fetching experimentation units usage
• Added beta endpoint for fetching experimentation keys usage
• Added experimentalProperties field to experiment create post body
• Added randomizationUnit to
  • the IterationInput object
  • the responses for getExperiment, getExperiments, and createIteration
• Added randomizationUnits to
  • the MetricPost object
  • the responses for getMetric and getMetrics
• Added beta endpoint for retrieving experimentation settings for a given project
• Added beta endpoint for updating experimentation settings for a given project
• Added beta endpoints getting experimentation keys usage

Removed

Changed

• Updated title of getAuditLogEntries to reflect that audit logs aren't specific to feature flags
• Updated operation ID postApprovalRequest to postApprovalRequestForFlag to reflect that it's flag specific. The title has also been updated to reflect this.
• Updated operation ID postApprovalRequestReview to postApprovalRequestReviewForFlag to reflect that it's flag specific. The title has also been updated to reflect this.
• Updated operation ID postApprovalRequestApplyRequest to postApprovalRequestApplyForFlag to reflect that it's flag specific. The title has also been updated to reflect this.
• Updated operation ID deleteApprovalRequest to deleteApprovalRequestForFlag to 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 endpoint getApprovalRequests. Support for the old syntax is being dropped. See documentation for new syntax.
• Updated type of Links in FlagConfigApprovalRequestResponse

Bug Fixes

• Fixing postWorkflow beta endpoint
  • name is required (previously incorrectly marked as optional)
  • description is optional (previously incorrectly marked as required)

11.0.0

[11.0.0] - 2022-11-21

Added

• Added beta Workflow templates endpoints
• added structs for Flag Reuse to be expanded upon later
• Added targetingRuleDescription to experiment iteration flag response
• Added targetingRuleClauses to experiment iteration flag response
• Added probabilityOfMismatch to experiment result response
• Added archivedDate field to experiment response, omitted when experiment is not archived
• Added archivedDate field to expanded experiment for the Get metric endpoint, omitted when experiment is not archived
• Added lifecycleState parameter to Get experiments to query by archived and/or active experiments
• Added _idpSynced parameter to Team object
• Added beta endpoints for flag defaults
• Added beta endpoint for bulk editing members
• Added beta endpoint for bulk editing teams
• Added MaintainerTeam in preparation for teams as flag maintainers (not yet released)
• Add beta endpoints for Approval Requests

Removed

Changed

• Updated beta create workflow endpoint to allow for creating a workflow from a template
• In the Experiments endpoints, updated the existing kind field in the metric types to only include the allowed enum values (pageview, click, custom)
• Get metric experiments field is expandable, omitted by default
• Get metric experimentCount field is expandable, omitted by default
• Get metric list experimentCount field is expandable, omitted by default
• Renamed ExpiringUserTargetError to ExpiringTargetError to prepare for expiring context targets
• New code reference repositories will set the defaultBranch to main if you do not specify a value during creation
• In repository endpoints, gitlab is now a supported repoType
• In the flag creation endpoint, updated endpoint to replace applicable null values with project-level flag defaults
• Renamed getApprovals and getApproval endpoints to getApprovalsForFlag and getApprovalForFlag respectively

Bug Fixes

• Updated OpenAPI specification to include the missing sort query param on GET /projects
• Updated ResourceIdentifier from an empty Object to a string type
• Updated UUID to be a string with format uuid

10.0.0

[10.0.0] - 2022-07-12

Added

• Support for federal server https://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

[9.0.1] - 2022-04-29

Changed:

• Changes to Experiments (beta) endpoints