Repository navigation
Document ticket and conversation attribute errors, and fix ticket field shapes - #781
Merged
Merged
Conversation
…changes Add the missing 400, 404, 422 and 500 responses for the ticket, ticket type, ticket type attribute and conversation attribute endpoints, with examples that match what the API returns. Add company_id to tickets, is_internal to ticket types, and app_package_code to ticket replies. Make input_options and admin_id nullable, correct the ticket state ticket_types item shape, and stop marking contacts (create ticket) and description (create ticket type attribute) as required. List attributes now require at least 2 options, and relationship attributes require a reference with an object_type_id. Applied to 2.17 and Preview. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Spell out when a ticket can be shared, clarify what internal ticket types mean, stop the create ticket example sending a channel for a back-office ticket, and show a null request_id on the conversation attribute errors that return one. Applied to 2.17 and Preview. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
markdennis22
left a comment
Contributor
There was a problem hiding this comment.
Thanks! I checked that both versions parse with no dangling refs, that Fern check is unchanged, that the Preview SDK gets no new unknown types, and the described behaviour against the API.
A few questions:
- Create a ticket 200 example
channel: The change removeschannel: messengerfrom the 200 response example in 2.17 and Preview. Ticket responses always includechannel, and a ticket created through the API reportsmessenger. Could you restore it? Only the request example should dropchannel: email. - Delete a ticket 404 code: The reference said
ticket_not_found"Ticket not found". The API returnsnot_found"Resource Not Found", while linking and unlinking a missing ticket returnticket_not_found. Should the reference keepticket_not_founduntil the API changes, or describenot_found? company_idexample: The example is UUID-shaped, copied from the request schema. Should it match the company id format used elsewhere in the reference?
Approval is waiting on the fix for 1 and a decision on 2.
~ Automated via Claude
…d example Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Thanks!
~ Automated via Claude |
markdennis22
approved these changes
Oct 29, 2026
markdennis22
left a comment
Contributor
There was a problem hiding this comment.
Thanks! I re-checked the latest changes merged with main: both versions parse with no dangling refs, Fern check is unchanged, and the Preview SDK gets no new unknown types. channel: messenger is back in the Create a ticket 200 example, and the company_id example now matches the rest of the reference.
Approving.
~ Automated via Claude
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The ticket, ticket type and conversation attribute operations in the 2.17 and Preview references leave out most of the errors the API returns, show some impossible examples, and get several field shapes wrong:
company_idandis_internalare missing, two request fields are marked required when the API doesn't need them, and the ticket state summary is typed as a full ticket type.How?
Corrects each operation in both versions to match the API's current behaviour.
Risks
Preview types reach the generated SDKs:
ticket.company_id,ticket_type.is_internalandticket_reply.app_package_code;input_optionsand conversation attributeadmin_idbecome nullable.ticket_state_detailed.ticket_typesitems become an inline summary instead of the full ticket type.create_ticket_request.contacts(Tracker types may omit it) andcreate_ticket_type_attribute_request.descriptionstop being required.options(at least 2); relationship attribute create needsreference.object_type_id.Generated with Claude Code