Repository navigation
Align shared pagination and error schemas with API responses - #737
Merged
Merged
Conversation
- Add an optional `prev` link to the `pages_link` pagination object.
- Describe `cursor_pages.next` as the `{page, starting_after}` object the API returns.
- Use `pages_link` for the article, article version, collection, help center redirect and internal article list responses.
- Replace the `field` property on error items with an optional `data` object.
- Correct the example error codes for not found, validation and bad request responses.
- Drop the default from the Intercom-Version header schema and describe the fallback when it is omitted.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
yasser-aboelgheit-intercom
left a comment
yasser-aboelgheit-intercom
left a comment
Contributor
There was a problem hiding this comment.
Looks right to me. One question:
- The description says
pages.next"arrives as a URL string" on the article, collection, help center redirect and internal article lists. From what I can see, the help center redirect list,GET /internal_articlesandGET /internal_articles/searchsend onlytype,page,per_pageandtotal_pages, with nonextorprev.pages_linkstill fits because both links are optional, but is it worth narrowing the wording so nobody expects links on those three?
~ Automated via Claude
yasser-aboelgheit-intercom
previously approved these changes
Oct 21, 2026
- Some page-number lists never include next or prev links, so the next link description now says to compare page with total_pages. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
cathalging
force-pushed
the
cathalging/b0-shared-schemas
branch
from
October 21, 2026 11:18
3050d41 to
bd7f40d
Compare
Contributor
Author
|
Good catch, fixed in bd7f40d. The |
yasser-aboelgheit-intercom
approved these changes
Oct 21, 2026
yasser-aboelgheit-intercom
left a comment
yasser-aboelgheit-intercom
left a comment
Contributor
There was a problem hiding this comment.
Thanks, the pages_link.next wording now matches what the lists send. Checked again on the latest head: the spec parses, every $ref resolves, and fern check passes with no new warnings. 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?
Several shared schemas in the 2.17 and Preview specs describe responses the API never sends. Examples: cursor pages on lists that use page numbers, an error
fieldthat is never returned, and a version default of 2.17 when a missing header actually falls back to the app's configured version.How?
Fixes the shared pagination, error and version schemas to match what the API returns. Points the article, collection, help center redirect and internal article lists at page-number pagination.
Generated with Claude Code