import Intro from '/docs/snippets/breaking-change-page-intro.md'
import MigrationIntro from '/docs/snippets/breaking-change-page-migration-intro.md'

publicationState is removed and replaced by status#

In Strapi 5, the publicationState parameter is replaced with status, which accepts draft and published values instead of live and preview.

In Strapi 5, the Draft & Publish feature has been reworked, and the Content API, including REST, GraphQL, and Document Service APIs accept a new status parameter.

Breaking change description#

In Strapi v4

publicationState is used and accepts the following values:

• live returns only published entries,
• preview returns both draft entries & published entries.

In Strapi 5

status is used and accepts the following values:

• draft returns the draft version of a document,
• published returns the published version of a document.

Migration#

Notes#

• There are no fallbacks to return by default the published version, and return the draft version if no published version is found.
• status is only accepted at the root of a query, and it also applies to populated relations. Adding status inside a populate object is not supported: the REST API returns a 400 error, and the Document Service API throws a ValidationError. For details, see REST API: status and Document Service API: status.
• Additional information about how to use the new status parameter can be found in the REST API, GraphQL API, and Document Service API documentation.

Migration procedure#

• API calls initiated from the front end (REST API, GraphQL API) that used publicationState need to be manually updated.
• If publicationState is used in your custom back-end code with the Entity Service API in Strapi v4, a codemod will automatically handle the change for Strapi 5 (see Entity Service to Document Service migration reference for additional details).