launchdarkly_api 5.0.2 → 5.4.0

data/openapi.yml

@@ -10,7 +10,7 @@ info:
   license:
     name: Apache 2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
-  version: 5.0.2
+  version: 5.4.0
 host: app.launchdarkly.com
 basePath: /api/v2
 schemes:
@@ -145,7 +145,13 @@ paths:
       tags:
         - Environments
     patch:
-      summary: Modify an environment by ID.
+      summary: >-
+        Modify an environment by ID. If you try to patch the environment by
+        setting both required and requiredApprovalTags, it will result in an
+        error. Users can specify either required approvals for all flags in an
+        environment or those with specific tags, but not both. Only customers on
+        an Enterprise plan can require approval for flag updates with either
+        mechanism.
       operationId: patchEnvironment
       parameters:
         - $ref: '#/parameters/ProjectKey'
@@ -436,6 +442,49 @@ paths:
           $ref: '#/responses/Standard409'
       tags:
         - Feature flags
+  '/flags/{projectKey}/{featureFlagKey}/dependent-flags':
+    get:
+      summary: >-
+        Get dependent flags across all environments for the flag specified in
+        the path parameters
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+      responses:
+        '200':
+          description: Dependent flags accross all environemnts in the project response
+          schema:
+            $ref: '#/definitions/MultiEnvironmentDependentFlags'
+        '401':
+          $ref: '#/responses/Standard401'
+        '403':
+          $ref: '#/responses/BetaApi403'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+  '/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags':
+    get:
+      summary: >-
+        Get dependent flags for the flag in the environment specified in path
+        parameters
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+      responses:
+        '200':
+          description: Dependent flags in a single envrionemnt response
+          schema:
+            $ref: '#/definitions/DependentFlagsByEnvironment'
+        '401':
+          $ref: '#/responses/Standard401'
+        '403':
+          $ref: '#/responses/BetaApi403'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
   '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes':
     get:
       summary: Get all scheduled workflows for a feature flag by key.
@@ -579,6 +628,28 @@ paths:
           $ref: '#/responses/Standard404'
       tags:
         - Feature flags
+  '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy':
+    post:
+      operationId: postApprovalRequestFlagCopy
+      summary: Create an approval request to copy feature flag config
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/ApprovalRequestFlagCopyPostRequest'
+      responses:
+        '201':
+          schema:
+            $ref: '#/definitions/ApprovalRequest'
+          description: Approval request applied response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+        '409':
+          $ref: '#/responses/Standard409'
+      tags:
+        - Feature flags
   '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}':
     get:
       operationId: getApprovalRequest
@@ -591,7 +662,7 @@ paths:
       responses:
         '200':
           schema:
-            $ref: '#/definitions/ApprovalRequests'
+            $ref: '#/definitions/ApprovalRequest'
           description: Approval request response
         '401':
           $ref: '#/responses/Standard401'
@@ -609,7 +680,7 @@ paths:
         - $ref: '#/parameters/ApprovalRequestId'
         - $ref: '#/parameters/ApprovalRequestPostRequest'
       responses:
-        '200':
+        '201':
           schema:
             $ref: '#/definitions/ApprovalRequest'
           description: Approval request response
@@ -650,7 +721,7 @@ paths:
       responses:
         '200':
           schema:
-            $ref: '#/definitions/ApprovalRequests'
+            $ref: '#/definitions/ApprovalRequest'
           description: Approval request applied response
         '401':
           $ref: '#/responses/Standard401'
@@ -671,7 +742,7 @@ paths:
       responses:
         '200':
           schema:
-            $ref: '#/definitions/ApprovalRequests'
+            $ref: '#/definitions/ApprovalRequest'
           description: Approval request reviewed response
         '401':
           $ref: '#/responses/Standard401'
@@ -810,15 +881,15 @@ paths:
           $ref: '#/responses/Standard409'
       tags:
         - User segments
-  '/segments/{projectKey}/{environmentKey}/{userSegmentKey}/unbounded-users':
+  '/segments/{projectKey}/{environmentKey}/{userSegmentKey}/users':
     post:
-      summary: Update targets included or excluded in an unbounded segment
-      operationId: updatedUnboundedSegmentTargets
+      summary: Update targets included or excluded in a big segment
+      operationId: updateBigSegmentTargets
       parameters:
         - $ref: '#/parameters/ProjectKey'
         - $ref: '#/parameters/EnvironmentKey'
         - $ref: '#/parameters/UserSegmentKey'
-        - $ref: '#/parameters/UnboundedSegmentTargetsPostRequest'
+        - $ref: '#/parameters/BigSegmentTargetsPostRequest'
       responses:
         '204':
           $ref: '#/responses/Standard204'
@@ -2317,19 +2388,23 @@ definitions:
       status:
         type: string
         description: >
-          | Name     | Description |
+          | Name      | Description |
 
-          | --------:| ----------- |
+          | ---------:| ----------- |
 
-          | pending  | the approval request has not been applied yet |
+          | pending   | the approval request has not been applied yet |
 
-          | completed| the approval request has been applied successfully |
+          | completed | the approval request has been applied successfully |
 
-          | failed   | the approval request has been applied but the changes
+          | scheduled | the approval request for a scheduled change has been
+          applied successfully |
+
+          | failed    | the approval request has been applied but the changes
           were not applied successfully |
         enum:
           - pending
           - completed
+          - scheduled
           - failed
       appliedByMemberID:
         type: string
@@ -2352,6 +2427,24 @@ definitions:
           - memberId2
       instructions:
         $ref: '#/definitions/SemanticPatchInstruction'
+      executionDate:
+        type: integer
+        format: int64
+        description: Timestamp for when instructions will be executed
+      operatingOnId:
+        type: string
+        description: ID of scheduled change to edit or delete
+      source:
+        $ref: '#/definitions/Source'
+  Source:
+    type: object
+    properties:
+      key:
+        type: string
+        description: Environment key to be copied from
+      version:
+        type: integer
+        description: Version of environment at time of request
   ApprovalRequestReview:
     type: object
     properties:
@@ -2430,12 +2523,12 @@ definitions:
       default:
         type: object
       _links:
-        $ref: '#/definitions/Links'
+        $ref: '#/definitions/FeatureFlagStatusLinks'
   FeatureFlagStatuses:
     type: object
     properties:
       _links:
-        $ref: '#/definitions/Links'
+        $ref: '#/definitions/FeatureFlagStatusLinks'
       items:
         type: array
         items:
@@ -2476,13 +2569,94 @@ definitions:
     type: object
     properties:
       _links:
-        $ref: '#/definitions/Links'
+        $ref: '#/definitions/FeatureFlagStatusLinks'
       key:
         type: string
       environments:
         type: object
         additionalProperties:
           $ref: '#/definitions/FeatureFlagStatusForQueriedEnvironment'
+  FeatureFlagStatusLinks:
+    type: object
+    properties:
+      parent:
+        $ref: '#/definitions/Link'
+      self:
+        $ref: '#/definitions/Link'
+  DependentFlagsByEnvironment:
+    type: object
+    properties:
+      items:
+        type: array
+        items:
+          $ref: '#/definitions/DependentFlag'
+      _links:
+        $ref: '#/definitions/DependentFlagsLinks'
+      _site:
+        $ref: '#/definitions/Site'
+  DependentFlag:
+    type: object
+    properties:
+      name:
+        type: string
+      key:
+        type: string
+      _links:
+        type: object
+        properties:
+          self:
+            $ref: '#/definitions/Link'
+      _site:
+        $ref: '#/definitions/Site'
+  DependentFlagsLinks:
+    type: object
+    properties:
+      parent:
+        $ref: '#/definitions/Link'
+      self:
+        $ref: '#/definitions/Link'
+  MultiEnvironmentDependentFlags:
+    type: object
+    properties:
+      items:
+        type: array
+        items:
+          $ref: '#/definitions/MultiEnvironmentDependentFlag'
+      _links:
+        $ref: '#/definitions/DependentFlagsLinks'
+      _site:
+        $ref: '#/definitions/Site'
+  MultiEnvironmentDependentFlag:
+    type: object
+    properties:
+      name:
+        type: string
+      key:
+        type: string
+      environments:
+        type: array
+        items:
+          $ref: '#/definitions/DependentFlagEnvironment'
+      _links:
+        $ref: '#/definitions/DependentFlagsLinks'
+      _site:
+        $ref: '#/definitions/Site'
+  DependentFlagEnvironment:
+    type: object
+    properties:
+      name:
+        type: string
+      key:
+        type: string
+      _links:
+        type: object
+        properties:
+          self:
+            $ref: '#/definitions/Link'
+          flagLink:
+            $ref: '#/definitions/Link'
+      _site:
+        $ref: '#/definitions/Site'
   UserTargetingExpirationForFlags:
     type: object
     properties:
@@ -2617,9 +2791,10 @@ definitions:
         type: boolean
         example: false
         description: >-
-          Controls whether this segment can support unlimited numbers of users.
-          Requires the beta API and additional setup. Include/exclude lists in
-          this payload are not used in unbounded segments.
+          Controls whether this is considered a "big segment" which can support
+          an unlimited numbers of users. Include/exclude lists sent with this
+          payload are not used in big segments. Contact your account manager for
+          early access to this feature.
       version:
         type: integer
       _links:
@@ -2649,7 +2824,7 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/UserSegment'
-  UnboundedSegmentTargetChanges:
+  BigSegmentTargetChanges:
     type: object
     properties:
       add:
@@ -2861,7 +3036,8 @@ definitions:
             type: boolean
             description: >-
               Whether any changes to flags in this environment will require
-              approval.
+              approval. You may only set required or requiredApprovalTags, not
+              both.
           canReviewOwnRequest:
             type: boolean
             description: >-
@@ -2879,6 +3055,14 @@ definitions:
             description: >-
               Whether changes can be applied as long as minNumApprovals is met,
               regardless of if any reviewers have declined a request.
+          requiredApprovalTags:
+            type: array
+            items:
+              type: string
+            description: >-
+              An array of tags used to specify which flags with those tags
+              require approval. You may only set requiredApprovalTags or
+              required, not both.
   EnvironmentPost:
     type: object
     properties:
@@ -4042,9 +4226,10 @@ parameters:
           type: boolean
           example: false
           description: >-
-            Controls whether this segment can support unlimited numbers of
-            users. Requires the beta API and additional setup. Include/exclude
-            lists in this payload are not used in unbounded segments.
+            Controls whether this is considered a "big segment" which can
+            support an unlimited numbers of users. Include/exclude lists sent
+            with this payload are not used in big segments. Contact your account
+            manager for early access to this feature.
         tags:
           type: array
           items:
@@ -4054,20 +4239,20 @@ parameters:
       required:
         - name
         - key
-  UnboundedSegmentTargetsPostRequest:
-    name: unboundedSegmentTargetsBody
+  BigSegmentTargetsPostRequest:
+    name: bigSegmentTargetsBody
     in: body
     required: true
     description: >-
-      Add or remove user targets to the included or excluded lists on an
-      unbounded segment
+      Add or remove user targets to the included or excluded lists on a big
+      segment. Contact your account manager for early access to this feature.
     schema:
       type: object
       properties:
         included:
-          $ref: '#/definitions/UnboundedSegmentTargetChanges'
+          $ref: '#/definitions/BigSegmentTargetChanges'
         excluded:
-          $ref: '#/definitions/UnboundedSegmentTargetChanges'
+          $ref: '#/definitions/BigSegmentTargetChanges'
   ProjectPostRequest:
     name: projectBody
     in: body
@@ -4604,10 +4789,55 @@ parameters:
         comment:
           type: string
           description: comment will be included in audit log item for change.
+        executionDate:
+          type: integer
+          format: int64
+          description: Timestamp for when instructions will be executed
+        operatingOnId:
+          type: string
+          description: ID of scheduled change to edit or delete
       required:
         - description
         - instructions
         - notifyMemberIds
+  ApprovalRequestFlagCopyPostRequest:
+    name: approvalRequestFlagConfigCopyBody
+    in: body
+    description: Create a new approval request
+    schema:
+      type: object
+      properties:
+        description:
+          type: string
+          description: >-
+            A name that describes the changes you would like to apply to a
+            feature flag configuration
+        notifyMemberIds:
+          type: array
+          items:
+            type: string
+          example:
+            - memberId
+            - memberId2
+        source:
+          $ref: '#/definitions/Source'
+        comment:
+          type: string
+          description: comment will be included in audit log item for change.
+        includedActions:
+          type: array
+          items:
+            $ref: '#/definitions/CopyActions'
+          description: Define the parts of the flag configuration that will be copied.
+        excludedActions:
+          type: array
+          items:
+            $ref: '#/definitions/CopyActions'
+          description: Define the parts of the flag configuration that will not be copied.
+      required:
+        - description
+        - notifyMemberIds
+        - source
   ApprovalRequestReviewPostRequest:
     name: approvalRequestReviewConfigBody
     in: body