Update API schema and docs

incident-io · Jan 22, 2025 · 731b5bb · 731b5bb
1 parent 9c46f33
commit 731b5bb
Show file tree

Hide file tree

Showing 7 changed files with 290 additions and 88 deletions.
diff --git a/docs/resources/custom_field.md b/docs/resources/custom_field.md
@@ -9,8 +9,6 @@ description: |-
   your own data needs.
   Each field has a type:
   Single-select, single value selected from a predefined list of options (e.g. Detection Method)Multi-select, as above but you can pick more than one option (e.g. Affected Teams)Text, freeform text field (e.g. Customer ID)Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)Number, integer or fractional numbers (e.g. # Customers Affected)
-  Single-select and multi-select fields can also be powered by the Catalog. This will mean a field has a
-  catalogtypeid, which links it to the catalog type that it references.
   We may add more custom field types in the future - we'd love to hear any other types you'd like to use!
 ---
 
@@ -30,9 +28,6 @@ Each field has a type:
 - Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)
 - Number, integer or fractional numbers (e.g. # Customers Affected)
 
-Single-select and multi-select fields can also be powered by the Catalog. This will mean a field has a
-catalog_type_id, which links it to the catalog type that it references.
-
 We may add more custom field types in the future - we'd love to hear any other types you'd like to use!
 
 ## Example Usage

diff --git a/internal/apischema/openapi.json b/internal/apischema/openapi.json
@@ -502,7 +502,7 @@
           "Incident Attachments V1"
         ],
         "summary": "List Incident Attachments V1",
-        "description": "List all incident attachements for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.",
+        "description": "List all incident attachments for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.",
         "operationId": "Incident Attachments V1#List",
         "parameters": [
           {
@@ -600,7 +600,7 @@
           "Incident Attachments V1"
         ],
         "summary": "Delete Incident Attachments V1",
-        "description": "Unattaches an external resouce from an incident",
+        "description": "Unattaches an external resource from an incident",
         "operationId": "Incident Attachments V1#Delete",
         "parameters": [
           {
@@ -7850,6 +7850,9 @@
         "severity": {
           "$ref": "#/definitions/EngineParamBindingPayloadV2"
         },
+        "start_in_triage": {
+          "$ref": "#/definitions/EngineParamBindingPayloadV2"
+        },
         "summary": {
           "$ref": "#/definitions/EngineParamBindingPayloadV2"
         },
@@ -7924,6 +7927,18 @@
             "reference": "incident.severity"
           }
         },
+        "start_in_triage": {
+          "array_value": [
+            {
+              "literal": "SEV123",
+              "reference": "incident.severity"
+            }
+          ],
+          "value": {
+            "literal": "SEV123",
+            "reference": "incident.severity"
+          }
+        },
         "summary": {
           "array_value": [
             {
@@ -9275,6 +9290,18 @@
               "reference": "incident.severity"
             }
           },
+          "start_in_triage": {
+            "array_value": [
+              {
+                "literal": "SEV123",
+                "reference": "incident.severity"
+              }
+            ],
+            "value": {
+              "literal": "SEV123",
+              "reference": "incident.severity"
+            }
+          },
           "summary": {
             "array_value": [
               {
@@ -10506,6 +10533,18 @@
               "reference": "incident.severity"
             }
           },
+          "start_in_triage": {
+            "array_value": [
+              {
+                "literal": "SEV123",
+                "reference": "incident.severity"
+              }
+            ],
+            "value": {
+              "literal": "SEV123",
+              "reference": "incident.severity"
+            }
+          },
           "summary": {
             "array_value": [
               {
@@ -28465,11 +28504,6 @@
             }
           ]
         },
-        "id": {
-          "type": "string",
-          "description": "Unique identifier for the incident",
-          "example": "01FDAG4SAP5TYPT98WGR2N7W91"
-        },
         "idempotency_key": {
           "type": "string",
           "description": "Unique string used to de-duplicate incident create requests",
@@ -28581,7 +28615,6 @@
             ]
           }
         ],
-        "id": "01FDAG4SAP5TYPT98WGR2N7W91",
         "idempotency_key": "alert-uuid",
         "incident_role_assignments": [
           {
@@ -33083,8 +33116,9 @@
           "description": "The type of the related resource",
           "example": "schedule",
           "enum": [
-            "workflow",
-            "schedule"
+            "escalation_path",
+            "schedule",
+            "workflow"
           ]
         },
         "source_url": {
@@ -33134,8 +33168,9 @@
           "description": "The type of the related resource",
           "example": "schedule",
           "enum": [
-            "workflow",
-            "schedule"
+            "escalation_path",
+            "schedule",
+            "workflow"
           ]
         }
       },
@@ -41544,7 +41579,7 @@
     },
     {
       "name": "Custom Fields V2",
-      "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nSingle-select and multi-select fields can also be powered by the Catalog. This will mean a field has a\ncatalog_type_id, which links it to the catalog type that it references.\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n"
+      "description": "Manage custom fields.\n\nCustom fields are used to attach metadata to incidents, which you can use when searching\nfor incidents in the dashboard, triggering workflows, building announcement rules or for\nyour own data needs.\n\nEach field has a type:\n\n- Single-select, single value selected from a predefined list of options (e.g. Detection Method)\n- Multi-select, as above but you can pick more than one option (e.g. Affected Teams)\n- Text, freeform text field (e.g. Customer ID)\n- Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)\n- Number, integer or fractional numbers (e.g. # Customers Affected)\n\nWe may add more custom field types in the future - we'd love to hear any other types you'd like to use!\n"
     },
     {
       "name": "Escalations V2",

diff --git a/internal/apischema/openapi.yaml b/internal/apischema/openapi.yaml
@@ -472,7 +472,7 @@ paths:
             tags:
                 - Incident Attachments V1
             summary: List Incident Attachments V1
-            description: List all incident attachements for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.
+            description: List all incident attachments for a given external resource or incident. You must provide either a specific incident ID or a specific external resource type and external ID.
             operationId: Incident Attachments V1#List
             parameters:
                 - name: incident_id
@@ -542,7 +542,7 @@ paths:
             tags:
                 - Incident Attachments V1
             summary: Delete Incident Attachments V1
-            description: Unattaches an external resouce from an incident
+            description: Unattaches an external resource from an incident
             operationId: Incident Attachments V1#Delete
             parameters:
                 - name: id
@@ -5867,6 +5867,8 @@ definitions:
                     - severity-max
             severity:
                 $ref: '#/definitions/EngineParamBindingPayloadV2'
+            start_in_triage:
+                $ref: '#/definitions/EngineParamBindingPayloadV2'
             summary:
                 $ref: '#/definitions/EngineParamBindingPayloadV2'
             workspace:
@@ -5911,6 +5913,13 @@ definitions:
                 value:
                     literal: SEV123
                     reference: incident.severity
+            start_in_triage:
+                array_value:
+                    - literal: SEV123
+                      reference: incident.severity
+                value:
+                    literal: SEV123
+                    reference: incident.severity
             summary:
                 array_value:
                     - literal: SEV123
@@ -6708,6 +6717,13 @@ definitions:
                     value:
                         literal: SEV123
                         reference: incident.severity
+                start_in_triage:
+                    array_value:
+                        - literal: SEV123
+                          reference: incident.severity
+                    value:
+                        literal: SEV123
+                        reference: incident.severity
                 summary:
                     array_value:
                         - literal: SEV123
@@ -7413,6 +7429,13 @@ definitions:
                     value:
                         literal: SEV123
                         reference: incident.severity
+                start_in_triage:
+                    array_value:
+                        - literal: SEV123
+                          reference: incident.severity
+                    value:
+                        literal: SEV123
+                        reference: incident.severity
                 summary:
                     array_value:
                         - literal: SEV123
@@ -20269,10 +20292,6 @@ definitions:
                           value_option_id: 01FCNDV6P870EA6S7TK1DSYDG0
                           value_text: This is my text field, I hope you like it
                           value_timestamp: ""
-            id:
-                type: string
-                description: Unique identifier for the incident
-                example: 01FDAG4SAP5TYPT98WGR2N7W91
             idempotency_key:
                 type: string
                 description: Unique string used to de-duplicate incident create requests
@@ -20353,7 +20372,6 @@ definitions:
                       value_option_id: 01FCNDV6P870EA6S7TK1DSYDG0
                       value_text: This is my text field, I hope you like it
                       value_timestamp: ""
-            id: 01FDAG4SAP5TYPT98WGR2N7W91
             idempotency_key: alert-uuid
             incident_role_assignments:
                 - assignee:
@@ -23785,8 +23803,9 @@ definitions:
                 description: The type of the related resource
                 example: schedule
                 enum:
-                    - workflow
+                    - escalation_path
                     - schedule
+                    - workflow
             source_url:
                 type: string
                 description: The url of the external repository where this resource is managed (if there is one)
@@ -23824,8 +23843,9 @@ definitions:
                 description: The type of the related resource
                 example: schedule
                 enum:
-                    - workflow
+                    - escalation_path
                     - schedule
+                    - workflow
         example:
             annotations:
                 incident.io/terraform/version: 3.0.0