fix: Mark conversation_id as required in message schema#423
Open
markdennis22 wants to merge 1 commit intomainfrom
Open
fix: Mark conversation_id as required in message schema#423markdennis22 wants to merge 1 commit intomainfrom
markdennis22 wants to merge 1 commit intomainfrom
Conversation
The conversation_id field was missing from the required array in the message schema, making it appear optional in rendered API docs. This confused customers into thinking the Create Conversation endpoint might not always return a conversation ID. Added conversation_id to the required array across all versions (2.11 already had it). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
This adds
The spec itself already reflects this: the Suggested approach: use # before
schema:
"$ref": "#/components/schemas/message"
# after
schema:
allOf:
- "$ref": "#/components/schemas/message"
required:
- conversation_idLeave the shared |
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
conversation_idfield in themessageresponse schema is not marked as required, making it appear optional in the rendered API docs. A customer reported this was confusing — they thought there were cases where the Create Conversation API wouldn't return a conversation ID.How?
Added
conversation_idto therequiredarray in themessageschema across all API versions (v2.7–v2.10, v2.12–v2.15, and Unstable). Version 2.11 already had it and was left unchanged.What was confusing and how this fixes it
conversation_idrendered without a "required" badge in the response docsconversation_idnow shows the red "required" badge, matchingtype,id,created_at,body, andmessage_typeconversation_idis always returnedCompanion PR in developer-docs: intercom/developer-docs#798
Generated with Claude Code