Document maxLength on comment and other request fields - #60
Merged
Merged
Conversation
The maximum comment length was raised from 1,000 to 10,000 characters in outline/outline#13814. Document this limit on the comments.create text field, matching how documents document their body text maxLength. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A5XTVDVVYNbVFtppBGu3Sd
Add maxLength constraints to request-body string fields across endpoints to reflect the limits Outline actually enforces (shared/validations.ts): - apiKeys.create name (255) - collections.create/update/duplicate name (100), description (100000) - documents.create/update/duplicate title (100) - groups.create/update name (255), description (2000) - oauthClients.create/update name (100), description (255), developerName (100), developerUrl/avatarUrl/redirectUris items (1024) - revisions.update name (255) - users.update name (255) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A5XTVDVVYNbVFtppBGu3Sd
tommoor
changed the title
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
2 participants
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.
Summary
Reviewing pull requests merged to outline/outline in the last day, the only change affecting the public API input schema or output shape was:
This is documented on the
comments.createtextfield viamaxLength: 10000.Additional consistency pass
While here,
maxLengthwas added to request-body string fields across endpoints so the documented constraints match the limits Outline actually enforces inshared/validations.ts:apiKeys.createnamecollections.create/.update/.duplicatenamecollections.create/.updatedescriptiondocuments.create/.update/.duplicatetitlegroups.create/.updatenamegroups.createdescriptionoauthClients.create/.updatenameoauthClients.create/.updatedescriptionoauthClients.create/.updatedeveloperNameoauthClients.create/.updatedeveloperUrl,avatarUrl,redirectUris[]revisions.updatenameusers.updatenameFields that already carried a
maxLength(documentstext, share/webhook/collection-reason fields, etc.) were left unchanged. Endpoints with no corresponding validation constant (attachments, data attributes, comment anchors, webhooksecret) were left as-is.Other merged PRs reviewed — no doc change needed
UI/editor/internal-logic/bug fixes with no request or response schema impact: #13818, #13817, #13816, #13815, #13809.
Only
spec3.ymlwas hand-edited;spec3.jsonwas regenerated by the pre-commit hook.🤖 Generated with Claude Code
https://claude.ai/code/session_01A5XTVDVVYNbVFtppBGu3Sd