Skip to content

14.0.0

Compare
Choose a tag to compare
@sunnyguduru sunnyguduru released this 20 Nov 21:03
· 8 commits to main since this release

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
  • Added metricGroups and metricGroupCount expand parameters to the getMetric 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}
  • 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
  • Get metric metricGroups and metricGroupCount fields are expandable, omitted by default

Bug Fixes

  • RootResponse schema was incorrect