launchdarkly_api 3.8.0 → 3.9.0

data/lib/launchdarkly_api/models/webhooks.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/models/weighted_variation.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/version.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.8
 =end
 
 module LaunchDarklyApi
-  VERSION = '3.8.0'
+  VERSION = '3.9.0'
 end

data/openapi.yml

@@ -10,7 +10,7 @@ info:
   license:
     name: Apache 2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
-  version: 3.8.0
+  version: 3.9.0
 host: app.launchdarkly.com
 basePath: /api/v2
 schemes:
@@ -436,6 +436,105 @@ paths:
           $ref: '#/responses/Standard409'
       tags:
         - Feature flags
+  '/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests':
+    get:
+      operationId: getFeatureFlagChangeRequests
+      summary: Get all change requests for a feature flag
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/FeatureFlagChangeRequests'
+          description: Feature flag change requests response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+    post:
+      operationId: postFeatureFlagChangeRequest
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagChangeRequestPostRequest'
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/FeatureFlagChangeRequest'
+          description: Feature flag change request response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+  '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}':
+    get:
+      operationId: getFeatureFlagChangeRequest
+      summary: Get a single change request for a feature flag
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagChangeRequestId'
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/FeatureFlagChangeRequests'
+          description: Feature flag change request response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+  '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/apply':
+    post:
+      operationId: postApplyFeatureFlagChangeRequest
+      summary: Apply change request for a feature flag
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagChangeRequestId'
+        - $ref: '#/parameters/FeatureFlagChangeRequestApplyPostRequest'
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/FeatureFlagChangeRequests'
+          description: Feature flag change request applied response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+  '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/review':
+    post:
+      operationId: postReviewFeatureFlagChangeRequest
+      summary: Review change request for a feature flag
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagChangeRequestId'
+        - $ref: '#/parameters/FeatureFlagChangeRequestReviewPostRequest'
+      responses:
+        '200':
+          schema:
+            $ref: '#/definitions/FeatureFlagChangeRequests'
+          description: Feature flag change request reviewed response
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
   '/segments/{projectKey}/{environmentKey}':
     get:
       summary: Get a list of all user segments in the given project.
@@ -1894,6 +1993,8 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/Clause'
+      description:
+        type: string
   Fallthrough:
     type: object
     properties:
@@ -2022,6 +2123,106 @@ definitions:
       reason:
         type: string
         description: Feature flag scheduled change conflict reason
+  FeatureFlagChangeRequests:
+    type: object
+    properties:
+      _links:
+        $ref: '#/definitions/Links'
+      items:
+        type: array
+        items:
+          $ref: '#/definitions/FeatureFlagChangeRequest'
+  FeatureFlagChangeRequest:
+    type: object
+    properties:
+      _id:
+        $ref: '#/definitions/Id'
+      _version:
+        type: integer
+      creationDate:
+        type: integer
+        description: >-
+          A unix epoch time in milliseconds specifying the date the change
+          request was requested
+      requestorId:
+        type: string
+        description: The id of the member that requested the change
+      reviewStatus:
+        $ref: '#/definitions/FeatureFlagChangeRequestReviewStatus'
+      status:
+        type: string
+        description: >
+          | Name     | Description |
+
+          | --------:| ----------- |
+
+          | pending  | the feature flag change request has not been applied yet
+          |
+
+          | completed| the feature flag change request has been applied
+          successfully |
+
+          | failed   | the feature flag change request has been applied but the
+          changes were not applied successfully |
+        enum:
+          - pending
+          - completed
+          - failed
+      appliedByMemberID:
+        type: string
+        description: The id of the member that applied the change request
+      appliedDate:
+        type: integer
+        description: >-
+          A unix epoch time in milliseconds specifying the date the change
+          request was applied
+      currentReviewsByMemberId:
+        $ref: '#/definitions/FeatureFlagChangeRequestReview'
+      allReviews:
+        type: array
+        items:
+          $ref: '#/definitions/FeatureFlagChangeRequestReview'
+      notifyMemberIds:
+        type: array
+        items:
+          type: string
+        example:
+          - memberId
+          - memberId2
+      instructions:
+        $ref: '#/definitions/SemanticPatchInstruction'
+  FeatureFlagChangeRequestReview:
+    type: object
+    properties:
+      creationDate:
+        type: integer
+        description: >-
+          A unix epoch time in milliseconds specifying the date the change
+          request was reviewed
+      kind:
+        $ref: '#/definitions/FeatureFlagChangeRequestReviewStatus'
+      memberId:
+        $ref: '#/definitions/Id'
+      _id:
+        $ref: '#/definitions/Id'
+  FeatureFlagChangeRequestReviewStatus:
+    type: string
+    description: >
+      | Name     | Description |
+
+      | --------:| ----------- |
+
+      | pending  | the feature flag change request has not been reviewed yet |
+
+      | approved | the feature flag change request has been approved and can now
+      be applied |
+
+      | declined | the feature flag change request has been declined and cannot
+      be applied |
+    enum:
+      - pending
+      - approved
+      - declined
   ClientSideAvailability:
     type: object
     properties:
@@ -4139,6 +4340,73 @@ parameters:
       An expiration time for the old relay proxy configuration key, expressed as
       a Unix epoch time in milliseconds. By default, the relay proxy
       configuration will expire immediately
+  FeatureFlagChangeRequestId:
+    name: featureFlagChangeRequestId
+    in: path
+    required: true
+    description: The feature flag change request ID
+    type: string
+  FeatureFlagChangeRequestPostRequest:
+    name: featureFlagChangeRequestConfigBody
+    in: body
+    description: Create a new feature flag change 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
+        instructions:
+          $ref: '#/definitions/SemanticPatchInstruction'
+        notifyMemberIds:
+          type: array
+          items:
+            type: string
+          example:
+            - memberId
+            - memberId2
+        comment:
+          type: string
+          description: comment will be included in audit log item for change.
+      required:
+        - description
+        - instructions
+        - notifyMemberIds
+  FeatureFlagChangeRequestReviewPostRequest:
+    name: featureFlagChangeRequestReviewConfigBody
+    in: body
+    required: true
+    description: Review a feature flag change request
+    schema:
+      type: object
+      properties:
+        kind:
+          type: string
+          description: Either approve or decline change request
+          enum:
+            - approve
+            - decline
+          example: approve
+        comment:
+          type: string
+          description: comment will be included in audit log item for change.
+          example: This is a comment string
+      required:
+        - kind
+  FeatureFlagChangeRequestApplyPostRequest:
+    name: featureFlagChangeRequestApplyConfigBody
+    in: body
+    required: true
+    description: Apply a new feature flag change request
+    schema:
+      type: object
+      properties:
+        comment:
+          type: string
+          description: comment will be included in audit log item for change.
+          example: Applying approved changes
   IntegrationKey:
     name: integrationKey
     in: path

data/spec/api/access_tokens_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/audit_log_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/custom_roles_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/customer_metrics_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/data_export_destinations_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/environments_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/feature_flags_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.8.0
+OpenAPI spec version: 3.9.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -83,6 +83,33 @@ describe 'FeatureFlagsApi' do
     end
   end
 
+  # unit tests for get_feature_flag_change_request
+  # Get a single change request for a feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param feature_flag_change_request_id The feature flag change request ID
+  # @param [Hash] opts the optional parameters
+  # @return [FeatureFlagChangeRequests]
+  describe 'get_feature_flag_change_request test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_feature_flag_change_requests
+  # Get all change requests for a feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param [Hash] opts the optional parameters
+  # @return [FeatureFlagChangeRequests]
+  describe 'get_feature_flag_change_requests test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_feature_flag_status
   # Get the status for a particular feature flag.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
@@ -166,6 +193,21 @@ describe 'FeatureFlagsApi' do
     end
   end
 
+  # unit tests for post_apply_feature_flag_change_request
+  # Apply change request for a feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param feature_flag_change_request_id The feature flag change request ID
+  # @param feature_flag_change_request_apply_config_body Apply a new feature flag change request
+  # @param [Hash] opts the optional parameters
+  # @return [FeatureFlagChangeRequests]
+  describe 'post_apply_feature_flag_change_request test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for post_feature_flag
   # Creates a new feature flag.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
@@ -179,4 +221,32 @@ describe 'FeatureFlagsApi' do
     end
   end
 
+  # unit tests for post_feature_flag_change_request
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param [Hash] opts the optional parameters
+  # @option opts [FeatureFlagChangeRequestConfigBody] :feature_flag_change_request_config_body Create a new feature flag change request
+  # @return [FeatureFlagChangeRequest]
+  describe 'post_feature_flag_change_request test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_review_feature_flag_change_request
+  # Review change request for a feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param feature_flag_change_request_id The feature flag change request ID
+  # @param feature_flag_change_request_review_config_body Review a feature flag change request
+  # @param [Hash] opts the optional parameters
+  # @return [FeatureFlagChangeRequests]
+  describe 'post_review_feature_flag_change_request test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end