Add missing Draft & Publish availability note to methods overview#3119
Merged
pwizla merged 4 commits intostrapi:mainfrom May 6, 2026
Merged
Add missing Draft & Publish availability note to methods overview#3119pwizla merged 4 commits intostrapi:mainfrom
pwizla merged 4 commits intostrapi:mainfrom
Conversation
The Method Overview table lists publish(), unpublish(), and discardDraft() but does not indicate that these methods require Draft & Publish to be enabled on the content-type. Added a note admonition after the table to clarify this requirement before developers start writing code.
docs: add missing Draft & Publish availability note to method overview
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
pwizla
reviewed
May 6, 2026
pwizla
reviewed
May 6, 2026
pwizla
added
internal
Collaborator
|
Thank you, @GorkyDemircn! That's a very neat and meaningful addition, indeed. I directly edited some content:
The PR is now approved, merged, should be live on docs.strapi.io in a few minutes, and will be mentioned in the next weekly snapshot release. |
pwizla
approved these changes
May 6, 2026
pwizla
changed the title
Contributor
Author
|
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
3 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.
What does this PR do?
Adds a missing availability note after the Method Overview
table in the Document Service API reference page.
What was wrong?
The Method Overview table lists all 10 methods including
publish(), unpublish(), and discardDraft(). However, there
is no indication anywhere in the overview that these three
methods require Draft & Publish to be enabled on the
content-type.
A developer who has Draft & Publish disabled will see these
methods listed, call them, receive a confusing runtime error,
and find no explanation on this page.
Fix applied
Added a :::note admonition directly after the Method Overview
table clarifying that publish(), unpublish(), and
discardDraft() require Draft & Publish to be enabled.
Why it matters
Improves discoverability of a critical requirement at the
point where developers are first scanning the available
methods before they start writing code.
Related issue
No specific issue gap identified during architectural
analysis of the Strapi v5 Document Service API.