Skip to content

Document that shares.info id accepts a UUID or share slug - #56

Closed
tommoor wants to merge 1 commit into
mainfrom
claude/sleepy-gates-gw8ohu
Closed

tommoor wants to merge 1 commit into
mainfrom
claude/sleepy-gates-gw8ohu

Conversation

@tommoor

@tommoor tommoor commented Sep 17, 2026

Copy link
Copy Markdown
Member

Summary

Syncs the OpenAPI documentation with a change to Outline's API merged in the last day.

outline/outline#13766 ("fix: Validate share id on public share endpoints") applies zodShareIdType() to the id/shareId parameters of the public share endpoints. zodShareIdType() validates the value as either a UUID or a share slug (urlId), not a UUID alone.

For the documented shares.info endpoint, the spec previously declared id as format: uuid, which is misleadingly narrow. This PR relaxes that constraint and clarifies the description to match the actual contract, following the same convention already used elsewhere in the spec for "UUID or urlId" identifiers.

Changes

  • /shares.info id request property: removed format: uuid; description now reads "Unique identifier for the share. Either the UUID or the urlId (share slug) is acceptable."
  • spec3.json regenerated from the YAML via the pre-commit hook.

Other merged PRs reviewed (no doc changes needed)

The remaining PRs merged in the window touched the editor, performance, policies, plugins/webhooks, translations, or tests, none of which alter the documented public API input schema or output shape:

  • #13770, #13768, #13762, #13759, #13760 — editor/rendering & perf
  • #13764 — GitLab/GitHub webhook internals (plugins/, no API schema)
  • #13756, #13755 — frontend components
  • #13717 — document policies (authorization only)
  • #13765, #13758, #13757, #13761, #13763 — tests, admin service, imports, sign-in UX, translations

🤖 Generated with Claude Code

https://claude.ai/code/session_01YRFX22ngVHzgCBy5Pvy7BH


Generated by Claude Code

The shares.info endpoint validates its id parameter as either a UUID or a
share slug (urlId), not a UUID alone. Relax the misleading format: uuid
constraint and clarify the description to match the API contract.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YRFX22ngVHzgCBy5Pvy7BH
@tommoor

tommoor commented Sep 17, 2026

Copy link
Copy Markdown
Member Author

uuid is already documented as format.

@tommoor tommoor closed this Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants