add info about conflicting segments error

box · Jun 20, 2024 · e29c658 · e29c658
1 parent 82bb99a
commit e29c658
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/openapi.json b/openapi.json
@@ -24086,7 +24086,7 @@
           },
           "items": {
             "type": "array",
-            "description": "The items to be processed by the LLM, often files.\nTe array can include **exactly one** element.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.",
+            "description": "The items to be processed by the LLM, often files.\nThe array can include **exactly one** element.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.",
             "required": [
               "id",
               "type"
@@ -24578,7 +24578,7 @@
                 "items": {
                   "$ref": "#/components/schemas/SignRequestCreateSigner"
                 },
-                "description": "Array of signers for the signature request. 35 is the max number of signers permitted."
+                "description": "Array of signers for the signature request. 35 is the\nmax number of signers permitted.\n\n**Note**: It may happen that some signers belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).\nThis means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.\nIn such a case, an attempt to send the sign request will result in an error.\n\nRead more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ)."
               },
               "parent_folder": {
                 "allOf": [
@@ -33199,7 +33199,7 @@
                 "items": {
                   "$ref": "#/components/schemas/TemplateSigner"
                 },
-                "description": "Array of signers for the template."
+                "description": "Array of signers for the template.\n\n**Note**: It may happen that some signers specified in the template belong to conflicting [segments](r://shield-information-barrier-segment-member) (user groups).\nThis means that due to the security policies, users are assigned to segments to prevent exchanges or communication that could lead to ethical conflicts.\nIn such a case, an attempt to send the sign request based on a template listing signers in conflicting segments will result in an error.\n\nRead more about [segments and ethical walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ)."
               },
               "additional_info": {
                 "description": "Additional information on which fields are required and which fields are not editable.",
@@ -37196,10 +37196,10 @@
         }
       },
       "AppItemEventSource": {
-        "title": "AppItem Event source",
+        "title": "`AppItem` Event source",
         "type": "object",
         "x-box-resource-id": "app_item_event_source",
-        "description": "The AppItem that triggered an event in the event stream.",
+        "description": "The `AppItem` that triggered an event in the event stream.",
         "required": [
           "id",
           "type",
@@ -37208,7 +37208,7 @@
         "properties": {
           "id": {
             "type": "string",
-            "description": "The id of the AppItem",
+            "description": "The id of the `AppItem`",
             "example": "6374669741"
           },
           "type": {
@@ -37222,7 +37222,7 @@
           },
           "app_item_type": {
             "type": "string",
-            "description": "The type of the AppItem",
+            "description": "The type of the `AppItem`",
             "example": "hubs"
           },
           "user": {