Add ApplyNamespaceRules intent and comments

temporalio · Jan 28, 2025 · 9349b13 · 9349b13
1 parent 095bb20
commit 9349b13
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 32 deletions.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -1123,8 +1123,9 @@
         ]
       }
     },
-    "/api/v1/namespaces/{namespace}/rules/apply/{ruleId}": {
+    "/api/v1/namespaces/{namespace}/rules/apply": {
       "post": {
+        "summary": "ApplyNamespaceRule allows to apply rule to a certain workflow instance without creating a rule.\nThis is useful for one-off operations.",
         "operationId": "ApplyNamespaceRule2",
         "responses": {
           "200": {
@@ -1147,12 +1148,6 @@
             "required": true,
             "type": "string"
           },
-          {
-            "name": "ruleId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
           {
             "name": "body",
             "in": "body",
@@ -4313,8 +4308,9 @@
         ]
       }
     },
-    "/namespaces/{namespace}/rules/apply/{ruleId}": {
+    "/namespaces/{namespace}/rules/apply": {
       "post": {
+        "summary": "ApplyNamespaceRule allows to apply rule to a certain workflow instance without creating a rule.\nThis is useful for one-off operations.",
         "operationId": "ApplyNamespaceRule",
         "responses": {
           "200": {
@@ -4337,12 +4333,6 @@
             "required": true,
             "type": "string"
           },
-          {
-            "name": "ruleId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
           {
             "name": "body",
             "in": "body",
@@ -6212,7 +6202,16 @@
       }
     },
     "WorkflowServiceApplyNamespaceRuleBody": {
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "workflowExecutionInfo": {
+          "$ref": "#/definitions/v1WorkflowExecutionInfo"
+        },
+        "rule": {
+          "$ref": "#/definitions/v1NamespaceRule",
+          "description": "The rule to apply. Rule will be applied only to the matching workflow."
+        }
+      }
     },
     "WorkflowServiceCreateNamespaceRuleBody": {
       "type": "object",

diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml
@@ -1023,22 +1023,20 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Status'
-  /api/v1/namespaces/{namespace}/rules/apply/{ruleId}:
+  /api/v1/namespaces/{namespace}/rules/apply:
     post:
       tags:
         - WorkflowService
+      description: |-
+        ApplyNamespaceRule allows to apply rule to a certain workflow instance without creating a rule.
+         This is useful for one-off operations.
       operationId: ApplyNamespaceRule
       parameters:
         - name: namespace
           in: path
           required: true
           schema:
             type: string
-        - name: ruleId
-          in: path
-          required: true
-          schema:
-            type: string
       requestBody:
         content:
           application/json:
@@ -3838,22 +3836,20 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Status'
-  /namespaces/{namespace}/rules/apply/{ruleId}:
+  /namespaces/{namespace}/rules/apply:
     post:
       tags:
         - WorkflowService
+      description: |-
+        ApplyNamespaceRule allows to apply rule to a certain workflow instance without creating a rule.
+         This is useful for one-off operations.
       operationId: ApplyNamespaceRule
       parameters:
         - name: namespace
           in: path
           required: true
           schema:
             type: string
-        - name: ruleId
-          in: path
-          required: true
-          schema:
-            type: string
       requestBody:
         content:
           application/json:
@@ -5528,8 +5524,12 @@ components:
       properties:
         namespace:
           type: string
-        ruleId:
-          type: string
+        workflowExecutionInfo:
+          $ref: '#/components/schemas/WorkflowExecutionInfo'
+        rule:
+          allOf:
+            - $ref: '#/components/schemas/NamespaceRule'
+          description: The rule to apply. Rule will be applied only to the matching workflow.
     ApplyNamespaceRuleResponse:
       type: object
       properties: {}

diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto
@@ -2001,7 +2001,10 @@ message ListNamespaceRulesResponse {
 message ApplyNamespaceRuleRequest {
     string namespace = 1;
 
-    string rule_id = 2;
+    temporal.api.workflow.v1.WorkflowExecutionInfo workflow_execution_info = 2;
+
+    // The rule to apply. Rule will be applied only to the matching workflow.
+    temporal.api.namespace.v1.NamespaceRule rule = 3;
 }
 
 message ApplyNamespaceRuleResponse {

diff --git a/temporal/api/workflowservice/v1/service.proto b/temporal/api/workflowservice/v1/service.proto
@@ -1060,12 +1060,14 @@ service WorkflowService {
         };
     }
 
+    // ApplyNamespaceRule allows to apply rule to a certain workflow instance without creating a rule.
+    // This is useful for one-off operations.
     rpc ApplyNamespaceRule(ApplyNamespaceRuleRequest) returns (ApplyNamespaceRuleResponse) {
         option (google.api.http) = {
-            post: "/namespaces/{namespace}/rules/apply/{rule_id}"
+            post: "/namespaces/{namespace}/rules/apply"
             body: "*"
             additional_bindings {
-                post: "/api/v1/namespaces/{namespace}/rules/apply/{rule_id}"
+                post: "/api/v1/namespaces/{namespace}/rules/apply"
                 body: "*"
             }
         };