Releases: launchdarkly/api-client-python
Releases · launchdarkly/api-client-python
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
ruleClause
toParameterDefault
object - Added optional
oauthProviders
toMember
object - Added optional
templateKey
toCustomWorkflowInputRep
object - Added optional
notifyTeamKeys
parameter to- create approval
- create approval request to copy flag configurations across environments
- create workflow
Changed
- Changed
StatementRep
toStatement
- Using version 6.0.0 of OpenAPI generator
- Changes to beta experimentation API
- Renamed
StatementRep
toStatement
- 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
andstatus
inFlagConfigApprovalRequestResponse
kind
inReviewResponse
Bug Fixes
- Removed unintentionally exposed optional
variationJsonSchema
fromFeatureFlagBody
- Added missing
variations
toFlagSummary
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.0
[9.0.0] - 2022-04-12
Added:
- Added Experiments (beta) endpoints
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
POST /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments
GET /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}/iterations
GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments/{experimentKey}/metrics/{metricKey}/results
- Added optional
reason
toExecutionOutputRep
- Added
executeConditionsInSequence
toStageInputRep
- Added required
fileCount
toStatisticRep
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/featureStore
GET /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}/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}
- Added Teams (beta) endpoints
GET /api/v2/teams/{teamKey}/maintainers
GET /api/v2/teams/{teamKey}/roles
- Added optional
source
toEnvironmentPost
- Added
compare
query parameter toGET /api/v2/flags/{projectKey}
- Added
totalCountWithDifferences
property toFeatureFlags
object
Changed:
- Updates to our Teams (beta) endpoint
- Updates to our Worfklows (beta) endpoint
Removed:
- Removed
derived
property fromUser
object
Fixed:
- Added
409
conflict response toDELETE /api/v2/flags/{projectKey}/{featureFlagKey}
[7.1.1] - 2022-01-14
Changed:
- Renamed the body of Teams (beta) endpoint
postMemberTeams
fromMemberTeamsFormPost
toMemberTeamsPostInput
Fixed:
StatementPost
andStatementPostData
had incorrectly markedresources
andactions
as 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
to
andfrom
query parameters ingetExtinctions
- Added
ref
property torule
object - Added
commitTime
property tobranch
object
Changed:
- Switched from
minutesAgo
totimestamp
in our betaGET /api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}
response
Fixed:
successCriteria
property now expects astring
with valueHigherThanBaseline
orLowerThanBaseline
, it was previously incorrectly expecting anint
GET /api/v2/teams/{key}
was incorrectly returningTeamRep
. It’s been corrected to returnExpandedTeamRep
PATCH /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
, andfilter
query parameters forgetTeams
- Added
basePermissions
setting to custom roles - Added
filter
query parameter togetSearchUsers
- Added
sort
query parameter forgetSearchUsers
- Added
creationDate
toMember
- Added
metricSeen
toExperimentResultsRep
- Added
requireComments
,confirmChanges
toEnvironment
Changed:
- Return body of
getRoot
was previously undocumented - Post body of
postExtinction
was previously undocumented - Post body of
postMembers
was previously undocumented resources
andnotResources
types inStatementRep
was previously undocumentedenvironments
type inProjectPost
was previously undocumented- Renamed
Variate
toVariation
Fixed:
- Fixed
postCustomRole
post body - Fixed return type of
getCustomRole
- Fixed
customWorkflowMetaData
tocustomWorkflowMetadata
inFlagConfigApprovalRequestResponse
- Fixed
putBranch
post body - Fixed incorrect route for
postFlagCopyConfigApprovalRequest
- Fixed response body of
getUser
to return fulluser
payload - 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.