17.0.0

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 the kind field in DependentMetricOrMetricGroupRep to allow enum value standard, used for metric groups
• Added latestCommitTime field to the response of GET /api/v2/code-refs/statistics/{projectKey} (Get code references statistics for flags)
• Added optional statisticalMethodology field to the request body of POST /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 of GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
• Added links field to the response of GET /api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts
• Added limit and offset query parameters to GET /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 of POST /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 its name
• Updated PATCH /api/v2/projects/{projectKey}/flags/{flagKey} to include the ignoreConflicts query parameter
• Added variance field for each relative difference in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added varianceReduction field for each relative difference in the GET /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
• 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}
• Added totalCount field to the response body of GET /api/v2/metrics/{projectKey} (list metrics)
• Added pagination to GET /api/v2/projects/{projectKey}/metric-groups (list metric groups)
  • Added limit and offset query params
  • Added totalCount field to the response body
• Added optional attributes field to the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (create experiment) and POST /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 of POST /api/v2/flags/{projectKey} endpoint (Create Flag).
• Added eventValuesSum field for each treatment result in the GET /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, and bayesianBeta fields for each treatment result in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added optional methodology field to the request body of POST /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, and covariateImbalance fields for each treatment result in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint
• Added optional namingConvention field to the request body of POST /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 the filter param on GET /api/v2/projects/{projectKey}/metric-groups to search against the metric group name and key
• Added documentation for the filter param on GET /api/v2/projects/{projectKey}/metric-groups
• Added limit, offset, and asOf query parameters to the GET /api/v2/tags (List tags) endpoint
• Added optional limit field to GET /api/v2/projects/{projectKey}/environments/{environmentKey}/context-attributes
• Updated the distribution field in the GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results endpoint to always use number parameters
• 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)

Removed

• Removed the isDirty field from the Holdout responses 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}
• Removed statisticalMethodology field from the request body of POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments (Create experiment)
• Removed statisticalMethodology field 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 by env key
  • POST /api/v2/projects/{projectKey}/release-pipelines
  • GET /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
  • PATCH /api/v2/projects/{projectKey}/release-pipelines/{pipelineKey}
• Updated purpose enum on FlagPost input object to include holdout
• Deprecated the compare query parameter in the GET /api/v2/flags/{projectKey} (List feature flags) endpoint
• Updated deprecated as 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
• Updated default as optional on PUT /api/v2/projects/{projectKey}/experimentation-settings
• Updated totalCount as optional on GET /api/v2/segments/{projectKey}/{environmentKey}
• Update value as optional on PatchOperation since it is only required for certain JSON Patch operations
• Update Experiments (beta) tag to Experiments
• Updated iterations to include attributes field 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}
• Renamed PUT /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId} as putFlagFollower
• Renamed DELETE /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId} as deleteFlagFollower
• Updated the types of query parameters in the GET /api/v2/tags (List tags) endpoint

Bug Fixes

• Updated OpenAPI specification to include missing sort, limit and offset query params on the GET /api/v2/metrics/{projectKey} (list metrics) endpoint
• Fixed incorrect self and next links sometimes returned by the GET /api/v2/metrics/{projectKey} (list metrics) endpoint