Repository navigation
Align Knowledge endpoints in 2.17 and Preview with API responses - #762
Open
cathalging wants to merge 1 commit into
Open
cathalging wants to merge 1 commit into
cathalging wants to merge 1 commit into
Conversation
Correct the internal article, folder, content snippet, content search and bulk action operations so the spec matches what the API returns. - Add the OAuth scope line to the operations that lacked one - Document the real error responses (401 token scope, 400 and 422 validation, 404 unknown teammate or folder, live-experiment conflict) and fix examples whose codes or messages could not be produced - Document page and per_page on list and search internal articles, the optional admin_id on tag removal, and the locale and json_blocks request fields - Note that omitted keys (folder list fields, content search next and prev) are absent rather than null - Regenerate the internal article update and search examples with every returned field, and drop the heading the markdown output never emits - Add tags to the internal article list item (2.17) and widen the tag schema description to cover internal articles and content snippets Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch has not been deployed
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
1 participant
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 Knowledge operations (internal articles, folders, content snippets, content search and bulk actions) document errors the API never returns, leave out ones it does, and don't say which OAuth scope each one needs. Several examples also show fields or values the API doesn't send, so integrators build against the wrong contract.
How?
Each documented behaviour was checked against what the API returns, and the scopes, error responses, parameters and examples were corrected in both the 2.17 and Preview specs. No version after 2.17 changes these operations, so both get the same edits.
Generated with Claude Code