Skip to content

Commit 6fcccc0

Browse files
Shorten Preview conversation part type filter parameter descriptions
The 422 response examples already cover the error cases and the schema already states the 50-value limit, so each description is cut to two sentences. The 422 example now uses an obviously invalid name. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 9ab4926 commit 6fcccc0

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12707,7 +12707,7 @@ paths:
1270712707
- name: include_part_types
1270812708
in: query
1270912709
required: false
12710-
description: A comma-separated list of conversation part types to keep; only parts of these types are returned. Values are the names this version returns in a part's `part_type` field, such as `assignment`, `note` or `snoozed`; an unrecognised name returns a 422 rather than being silently ignored, so a typo fails loudly instead of filtering nothing. Two names need care — a part type this version does not recognise is returned as `unknown`, and `unknown` is not itself an accepted filter value, so those parts are removed by naming the types you do want rather than by filtering them out directly; and the part type that versions below 2.6 return as `note_and_reopen` is named `note_and_unsnooze` here. Up to 50 values are accepted, and `include_part_types` cannot be combined with `exclude_part_types`; both cases return a 422. Supply one comma-separated value; repeating the parameter is not read as a combined list, and only the last occurrence is used. The filter is applied before the conversation parts limit, so the newest matching parts are returned. Available on the Preview version; a 422 is returned on any other version.
12710+
description: A comma-separated list of conversation part types to return, such as `assignment`, `note` or `snoozed`. Cannot be combined with `exclude_part_types`.
1271112711
example: comment,note
1271212712
schema:
1271312713
type: array
@@ -12720,7 +12720,7 @@ paths:
1272012720
- name: exclude_part_types
1272112721
in: query
1272212722
required: false
12723-
description: A comma-separated list of conversation part types to drop; parts of these types are omitted and all others are returned. Values are the names this version returns in a part's `part_type` field, such as `assignment`, `note` or `snoozed`; an unrecognised name returns a 422 rather than being silently ignored, so a typo fails loudly instead of filtering nothing. Two names need care — a part type this version does not recognise is returned as `unknown`, and `unknown` is not itself an accepted filter value, so those parts are removed by naming the types you do want rather than by filtering them out directly; and the part type that versions below 2.6 return as `note_and_reopen` is named `note_and_unsnooze` here. Up to 50 values are accepted, and `include_part_types` cannot be combined with `exclude_part_types`; both cases return a 422. Supply one comma-separated value; repeating the parameter is not read as a combined list, and only the last occurrence is used. The filter is applied before the conversation parts limit, so the newest matching parts are returned. Available on the Preview version; a 422 is returned on any other version.
12723+
description: A comma-separated list of conversation part types to leave out, such as `assignment`, `note` or `snoozed`. Cannot be combined with `include_part_types`.
1272412724
example: assignment
1272512725
schema:
1272612726
type: array
@@ -13286,7 +13286,7 @@ paths:
1328613286
request_id: 1f2e3d4c-5b6a-4798-8c9d-0e1f2a3b4c5d
1328713287
errors:
1328813288
- code: parameter_invalid
13289-
message: 'Unknown conversation part types: coment'
13289+
message: 'Unknown conversation part types: foo'
1329013290
Filtering on the unknown part type:
1329113291
value:
1329213292
type: error.list

0 commit comments

Comments
 (0)