feat: implement rest update and delete segment REST (#1441)

Part of #1417 - Implement REST for update and delete segment - Remove command pattern - Add e2e test for no command segment API set
bucketeer-io · Jan 17, 2025 · 8c9ac26 · 8c9ac26
1 parent e79fc73
commit 8c9ac26
Show file tree

Hide file tree

Showing 24 changed files with 3,915 additions and 2,055 deletions.
diff --git a/api-description/web-api.swagger.yaml b/api-description/web-api.swagger.yaml
@@ -3330,6 +3330,57 @@ paths:
           type: string
       tags:
         - segment
+    delete:
+      summary: Delete
+      description: Delete a segment.
+      operationId: web.v1.segment.delete
+      responses:
+        "200":
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/featureDeleteSegmentResponse'
+        "400":
+          description: Returned for bad requests that may have failed validation.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 3
+              details: []
+              message: invalid arguments error
+        "401":
+          description: Request could not be authenticated (authentication required).
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 16
+              details: []
+              message: not authenticated
+        "503":
+          description: Returned for internal errors.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 13
+              details: []
+              message: internal
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: id
+          in: query
+          required: false
+          type: string
+        - name: environmentId
+          in: query
+          required: false
+          type: string
+      tags:
+        - segment
     post:
       summary: Create
       description: Create a segment.
@@ -3378,6 +3429,54 @@ paths:
             $ref: '#/definitions/featureCreateSegmentRequest'
       tags:
         - segment
+    patch:
+      summary: Update
+      description: Update a segment.
+      operationId: web.v1.segment.update
+      responses:
+        "200":
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/featureUpdateSegmentResponse'
+        "400":
+          description: Returned for bad requests that may have failed validation.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 3
+              details: []
+              message: invalid arguments error
+        "401":
+          description: Request could not be authenticated (authentication required).
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 16
+              details: []
+              message: not authenticated
+        "503":
+          description: Returned for internal errors.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+          examples:
+            application/json:
+              code: 13
+              details: []
+              message: internal
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/featureUpdateSegmentRequest'
+      tags:
+        - segment
   /v1/segment_users/bulk_upload:
     post:
       summary: Bulk upload
@@ -5976,8 +6075,30 @@ definitions:
     type: object
   featureUpdateFlagTriggerResponse:
     type: object
+  featureUpdateSegmentRequest:
+    type: object
+    properties:
+      id:
+        type: string
+      commands:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/featureCommand'
+        description: deprecated
+      environmentId:
+        type: string
+      name:
+        type: string
+      description:
+        type: string
+    required:
+      - environmentId
   featureUpdateSegmentResponse:
     type: object
+    properties:
+      segment:
+        $ref: '#/definitions/featureSegment'
   featureUserEvaluations:
     type: object
     properties:

diff --git a/manifests/bucketeer/charts/api/values.yaml b/manifests/bucketeer/charts/api/values.yaml
diff --git a/manifests/bucketeer/charts/web/values.yaml b/manifests/bucketeer/charts/web/values.yaml
diff --git a/pkg/domainevent/domain/message.go b/pkg/domainevent/domain/message.go
@@ -685,6 +685,14 @@ func LocalizedMessage(eventType proto.Event_Type, localizer locale.Localizer) *p
 				localizer.MustLocalizeWithTemplate(locale.Segment),
 			),
 		}
+	case proto.Event_SEGMENT_UPDATED:
+		return &proto.LocalizedMessage{
+			Locale: localizer.GetLocale(),
+			Message: localizer.MustLocalizeWithTemplate(
+				locale.UpdatedTemplate,
+				localizer.MustLocalizeWithTemplate(locale.Segment),
+			),
+		}
 	case proto.Event_SEGMENT_NAME_CHANGED:
 		return &proto.LocalizedMessage{
 			Locale: localizer.GetLocale(),