prepare 3.9.0 release (#68)

launchdarkly · Nov 20, 2020 · f28ca4f · f28ca4f
1 parent 493bbd0
commit f28ca4f
Show file tree

Hide file tree

Showing 6 changed files with 291 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -39,6 +39,7 @@ client-clones/
 # Auto generated files
 .DS_Store
 /swagger-codegen-cli-*.jar
+scripts/release/java/.gradle/*
 
 # IDE settings
 .classpath

diff --git a/Makefile b/Makefile
@@ -172,6 +172,10 @@ push:
 		$(GIT_COMMAND) tag $(TAG); \
 		$(GIT_PUSH_COMMAND) origin $(TAG); \
 		$(GIT_PUSH_COMMAND) origin $(RELEASE_BRANCH); \
+		if [ $(RELEASE_TARGET) == "go" ]; then \
+		  $(GIT_COMMAND) tag v$(TAG); \
+		  $(GIT_PUSH_COMMAND) origin v$(TAG); \
+		fi; \
 		cd ..; \
 	) \
 	if [ $(PREV_RELEASE_BRANCH) == "master" ]; then \

diff --git a/spec/definitions.yaml b/spec/definitions.yaml
@@ -270,6 +270,8 @@ Rule:
       type: array
       items:
         $ref: "#/definitions/Clause"
+    description:
+      type: string
 Fallthrough:
   type: object
   properties:
@@ -392,6 +394,85 @@ ScheduledChangesFeatureFlagConflict:
     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:
@@ -1567,7 +1648,7 @@ IntegrationSubscription:
       type: array
       items:
         type: string
-      description: An array of tags for this integration configuration. 
+      description: An array of tags for this integration configuration.
     _status:
       type: object
       properties:
@@ -1615,4 +1696,4 @@ Integrations:
       type: array
       items:
         type: object
-        $ref: "#/definitions/IntegrationSubscription"
+        $ref: "#/definitions/IntegrationSubscription"
diff --git a/spec/parameters.yaml b/spec/parameters.yaml
@@ -646,6 +646,67 @@ RelayProxyConfigsExpiry:
   type: integer
   format: int64
   description: 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

diff --git a/spec/paths.yaml b/spec/paths.yaml
@@ -24,6 +24,14 @@
   $ref: ./paths/flags.yaml#/FlagStatusAcrossEnvironments
 /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}:
   $ref: ./paths/flags.yaml#/UserTargetingExpirationForFlag
+/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests:
+  $ref: ./paths/flags.yaml#/FeatureFlagChangeRequests
+/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}:
+  $ref: ./paths/flags.yaml#/FeatureFlagChangeRequest
+/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/apply:
+  $ref: ./paths/flags.yaml#/ApplyFeatureFlagChangeRequest
+/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/review:
+  $ref: ./paths/flags.yaml#/ReviewFeatureFlagChangeRequest
 /segments/{projectKey}/{environmentKey}:
   $ref: ./paths/segments.yaml#/UserSegments
 /segments/{projectKey}/{environmentKey}/{userSegmentKey}:

diff --git a/spec/paths/flags.yaml b/spec/paths/flags.yaml
@@ -221,7 +221,6 @@ ScheduledFlagChanges:
       - $ref: '#/parameters/EnvironmentKeyQuery'
     responses:
       '200':
-        description: Flag response.
         schema:
           $ref: '#/definitions/FeatureFlagScheduledChanges'
       '401':
@@ -299,12 +298,145 @@ ScheduledFlagChangesConflicts:
       - $ref: '#/parameters/ScheduledFeatureFlagChangesPostRequest'
     responses:
       '200':
-        description: Flag response.
         schema:
           $ref: '#/definitions/FeatureFlagScheduledChangesConflicts'
       '401':
         $ref: '#/responses/Standard401'
       '404':
         $ref: '#/responses/Standard404'
+    tags:
+      - Feature flags
+FlagChangeRequest:
+  get:
+    operationId: getFeatureFlagChangeRequest
+    summary: Get a single feature flag change request by key
+    parameters:
+      - $ref: '#/parameters/ProjectKey'
+      - $ref: '#/parameters/FeatureFlagKey'
+      - $ref: '#/parameters/EnvironmentKey'
+      - $ref: '#/parameters/FeatureFlagChangeRequestId'
+    responses:
+      '200':
+        schema:
+          $ref: '#/definitions/FeatureFlagChangeRequest'
+      '401':
+        $ref: '#/responses/Standard401'
+      '404':
+        $ref: '#/responses/Standard404'
+    tags:
+      - Feature flags
+  delete:
+      operationId: deleteFeatureFlagChangeRequest
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagChangeRequestId'
+      responses:
+        '204':
+          $ref: '#/responses/Standard204'
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - Feature flags
+FeatureFlagChangeRequests:
+  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
+FeatureFlagChangeRequest:
+  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
+ApplyFeatureFlagChangeRequest:
+  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
+ReviewFeatureFlagChangeRequest:
+  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