[OAS] Add closeIncident subaction for run connector API (#175267)

elastic · Jan 23, 2024 · 67db684 · 67db684
1 parent 775199e
commit 67db684
Show file tree

Hide file tree

Showing 4 changed files with 137 additions and 0 deletions.
diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json
@@ -5263,6 +5263,65 @@
           }
         }
       },
+      "run_connector_subaction_closeincident": {
+        "title": "The closeIncident subaction",
+        "type": "object",
+        "required": [
+          "subAction",
+          "subActionParams"
+        ],
+        "description": "The `closeIncident` subaction for ServiceNow ITSM connectors.",
+        "properties": {
+          "subAction": {
+            "type": "string",
+            "description": "The action to test.",
+            "enum": [
+              "closeIncident"
+            ]
+          },
+          "subActionParams": {
+            "type": "object",
+            "required": [
+              "incident"
+            ],
+            "properties": {
+              "incident": {
+                "type": "object",
+                "anyOf": [
+                  {
+                    "required": [
+                      "correlation_id"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "externalId"
+                    ]
+                  }
+                ],
+                "properties": {
+                  "correlation_id": {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "description": "An identifier that is assigned to the incident when it is created by the connector. NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.\n",
+                    "maxLength": 100,
+                    "default": "{{rule.id}}:{{alert.id}}"
+                  },
+                  "externalId": {
+                    "type": [
+                      "null",
+                      "string"
+                    ],
+                    "description": "The unique identifier (`incidentId`) for the incident in ServiceNow."
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "run_connector_subaction_createalert": {
         "title": "The createAlert subaction",
         "type": "object",
@@ -5834,6 +5893,9 @@
                   {
                     "$ref": "#/components/schemas/run_connector_subaction_closealert"
                   },
+                  {
+                    "$ref": "#/components/schemas/run_connector_subaction_closeincident"
+                  },
                   {
                     "$ref": "#/components/schemas/run_connector_subaction_createalert"
                   },

diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml
@@ -3664,6 +3664,45 @@ components:
             user:
               type: string
               description: The display name for the owner.
+    run_connector_subaction_closeincident:
+      title: The closeIncident subaction
+      type: object
+      required:
+        - subAction
+        - subActionParams
+      description: The `closeIncident` subaction for ServiceNow ITSM connectors.
+      properties:
+        subAction:
+          type: string
+          description: The action to test.
+          enum:
+            - closeIncident
+        subActionParams:
+          type: object
+          required:
+            - incident
+          properties:
+            incident:
+              type: object
+              anyOf:
+                - required:
+                    - correlation_id
+                - required:
+                    - externalId
+              properties:
+                correlation_id:
+                  type:
+                    - 'null'
+                    - string
+                  description: |
+                    An identifier that is assigned to the incident when it is created by the connector. NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.
+                  maxLength: 100
+                  default: '{{rule.id}}:{{alert.id}}'
+                externalId:
+                  type:
+                    - 'null'
+                    - string
+                  description: The unique identifier (`incidentId`) for the incident in ServiceNow.
     run_connector_subaction_createalert:
       title: The createAlert subaction
       type: object
@@ -4062,6 +4101,7 @@ components:
               oneOf:
                 - $ref: '#/components/schemas/run_connector_subaction_addevent'
                 - $ref: '#/components/schemas/run_connector_subaction_closealert'
+                - $ref: '#/components/schemas/run_connector_subaction_closeincident'
                 - $ref: '#/components/schemas/run_connector_subaction_createalert'
                 - $ref: '#/components/schemas/run_connector_subaction_fieldsbyissuetype'
                 - $ref: '#/components/schemas/run_connector_subaction_getchoices'

diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/run_connector_request.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/run_connector_request.yaml
@@ -16,6 +16,7 @@ properties:
         oneOf:
           - $ref: 'run_connector_subaction_addevent.yaml'
           - $ref: 'run_connector_subaction_closealert.yaml'
+          - $ref: 'run_connector_subaction_closeincident.yaml'
           - $ref: 'run_connector_subaction_createalert.yaml'
           - $ref: 'run_connector_subaction_fieldsbyissuetype.yaml'
           - $ref: 'run_connector_subaction_getchoices.yaml'

diff --git a/...lugins/actions/docs/openapi/components/schemas/run_connector_subaction_closeincident.yaml b/...lugins/actions/docs/openapi/components/schemas/run_connector_subaction_closeincident.yaml
@@ -0,0 +1,34 @@
+title: The closeIncident subaction
+type: object
+required:
+  - subAction
+  - subActionParams
+description: The `closeIncident` subaction for ServiceNow ITSM connectors.
+properties:
+  subAction:
+    type: string
+    description: The action to test.
+    enum:
+      - closeIncident
+  subActionParams:
+    type: object
+    required:
+      - incident
+    properties:
+      incident:
+        type: object
+        anyOf:
+          - required: [correlation_id]
+          - required: [externalId] 
+        properties:
+          correlation_id:
+            type: ['null', string]
+            description: >
+              An identifier that is assigned to the incident when it is created by the connector.
+              NOTE: If you use the default value and the rule generates multiple alerts that use the same alert IDs, the latest open incident for this correlation ID is closed unless you specify the external ID.
+            maxLength: 100
+            default: '{{rule.id}}:{{alert.id}}'
+          externalId:
+            type: ['null', string]
+            description: The unique identifier (`incidentId`) for the incident in ServiceNow.
+