Releases: launchdarkly/api-client-python
Releases · launchdarkly/api-client-python
Release list
10.0.0
[10.0.0] - 2022-07-11
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
ruleClausetoParameterDefaultobject - Added optional
oauthProviderstoMemberobject - Added optional
templateKeytoCustomWorkflowInputRepobject - Added optional
notifyTeamKeysparameter to- create approval
- create approval request to copy flag configurations across environments
- create workflow
Changed
- Changed
StatementReptoStatement - Using version 6.0.0 of OpenAPI generator
- Changes to beta experimentation API
- Renamed
StatementReptoStatement - List projects has a default limit of 20, added support for filter and sort
- List projects
environmentfield is expandable, omitted by default - Get project
environmentfield is expandable, omitted by default - Changed
notifyMemberIdsfrom 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:
reviewStatusandstatusinFlagConfigApprovalRequestResponsekindinReviewResponse
Bug Fixes
- Removed unintentionally exposed optional
variationJsonSchemafromFeatureFlagBody - Added missing
variationstoFlagSummaryobject - 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.0
[9.0.0] - 2022-04-12
Added:
- Added Experiments (beta) endpoints
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experimentsPOST /api/v2/projects/{projectKey}/environments/{environmentKey}/experimentsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}PATCH /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/iterationsGET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
- Added optional
reasontoExecutionOutputRep - Added
executeConditionsInSequencetoStageInputRep - Added required
fileCounttoStatisticRep
Changed
- Changes to Experiments (beta) endpoints
8.0.0
[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}DELETE /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}PATCH /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id}
- Added Integration delivery configurations (beta) endpoints
GET /api/v2/integration-capabilities/featureStoreGET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}PATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate
- Added Segments (beta) endpoints
POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exportsGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/exports/{exportID}POST /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/importsGET /api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/imports/{importID}
- Added Teams (beta) endpoints
GET /api/v2/teams/{teamKey}/maintainersGET /api/v2/teams/{teamKey}/roles
- Added optional
sourcetoEnvironmentPost - Added
comparequery parameter toGET /api/v2/flags/{projectKey} - Added
totalCountWithDifferencesproperty toFeatureFlagsobject
Changed:
- Updates to our Teams (beta) endpoint
- Updates to our Worfklows (beta) endpoint
Removed:
- Removed
derivedproperty fromUserobject
Fixed:
- Added
409conflict response toDELETE /api/v2/flags/{projectKey}/{featureFlagKey}
[7.1.1] - 2022-01-14
Changed:
- Renamed the body of Teams (beta) endpoint
postMemberTeamsfromMemberTeamsFormPosttoMemberTeamsPostInput
Fixed:
StatementPostandStatementPostDatahad incorrectly markedresourcesandactionsas required properties
[7.1.0] - 2022-01-06
Added:
- Audit log subscription endpoints
GET /api/v2/integrations/{integrationKey}POST /api/v2/integrations/{integrationKey}GET /api/v2/integrations/{integrationKey}/{id}DELETE /api/v2/integrations/{integrationKey}/{id}PATCH /api/v2/integrations/{integrationKey}/{id}
- Flag trigger endpoints
GET /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}POST /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}GET /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}DELETE /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}PATCH /api/v2/flags/{projKey}/{flagKey}/triggers/{envKey}/{id}
- Teams (beta) endpoint
POST /api/v2/teams/{key}/members
- Account Members endpoint
POST /api/v2/members/{id}/teams
- Added
toandfromquery parameters ingetExtinctions - Added
refproperty toruleobject - Added
commitTimeproperty tobranchobject
Changed:
- Switched from
minutesAgototimestampin our betaGET /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}response
Fixed:
successCriteriaproperty now expects astringwith valueHigherThanBaselineorLowerThanBaseline, it was previously incorrectly expecting anintGET /api/v2/teams/{key}was incorrectly returningTeamRep. It’s been corrected to returnExpandedTeamRepPATCH /api/v2/teams/{key}was incorrectly returningTeamCollectionRep. It’s been corrected to returnExpandedTeamRep
[7.0.0] - 2021-12-03
Added:
- Workflows API (Beta)
- Teams API (Beta)
- Added
limit,offset, andfilterquery parameters forgetTeams - Added
basePermissionssetting to custom roles - Added
filterquery parameter togetSearchUsers - Added
sortquery parameter forgetSearchUsers - Added
creationDatetoMember - Added
metricSeentoExperimentResultsRep - Added
requireComments,confirmChangestoEnvironment
Changed:
- Return body of
getRootwas previously undocumented - Post body of
postExtinctionwas previously undocumented - Post body of
postMemberswas previously undocumented resourcesandnotResourcestypes inStatementRepwas previously undocumentedenvironmentstype inProjectPostwas previously undocumented- Renamed
VariatetoVariation
Fixed:
- Fixed
postCustomRolepost body - Fixed return type of
getCustomRole - Fixed
customWorkflowMetaDatatocustomWorkflowMetadatainFlagConfigApprovalRequestResponse - Fixed
putBranchpost body - Fixed incorrect route for
postFlagCopyConfigApprovalRequest - Fixed response body of
getUserto return fulluserpayload - Various required annotations fixed
[6.0.0] - 2021-09-02
Added:
- With the new OpenAPI specification, many additional resources have been added to the API clients. Refer to the client source code for more information.
- The Go API client generates with both pointers and types.
Changed:
- Replaced the manually-curated OpenAPI 2.0 specification with an OpenAPI 3.0 specification that is generated from annotations in our source code.
- Updated from Swagger Codegen v2.4.17 to OpenAPI Generator v5.2.1.
- With the new OpenAPI specification and the new generator, many models and resources have been changed for improved correctness, completeness, and consistency. Refer to the client source code for more information.
Deprecated:
- The Bash API client was not updated as part of this release and will no longer be maintained.
- The .NET API client was not updated as part of this release due to an issue in the generator library. In the meantime, the repository will remain frozen in the prior state. We will resume updates to the .NET API Client as soon as the generator bug is resolved.