Document share slug as a valid id for shares.info - #57
Merged
Merged
Conversation
The shares.info endpoint accepts either a UUID or a share slug for the id parameter (server-side validation via zodShareIdType). Update the documentation to reflect that the share slug is also acceptable, matching the actual accepted input. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JcjfwaotNz7pfJmehEsnkF
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
Reviewed pull requests merged to
outline/outlinein the last day and updated the OpenAPI documentation to reflect the one change affecting a documented, non-internal API endpoint.outline/outline#13766 – "Validate share id on public share endpoints" tightened input validation on the shares endpoints so that the
idparameter is validated withzodShareIdType(), which accepts either a UUID or a share slug. Theshares.infodocumentation previously declaredidasformat: uuidonly, which understated the accepted input.Changes
shares.info:idno longer carriesformat: uuidand its description now notes that either the UUID or the share slug is acceptable — matching the codebase and the existing convention used elsewhere in the spec (e.g.documents.info).Notes
spec3.yml) was edited by hand;spec3.jsonwas regenerated by the pre-commit hook.yarn validatepasses (Spectral lint, operation IDs, sort check).shares.sitemap,shares.subscribe) are on public web/email-flow endpoints that are not part of the documented API, so they were not changed.🤖 Generated with Claude Code
https://claude.ai/code/session_01JcjfwaotNz7pfJmehEsnkF
Generated by Claude Code