prismicio / prismic-types

Type definitions for Prismic content, models, and APIs
https://prismic.io/docs/technologies/javascript
Apache License 2.0
11 stars 4 forks source link

fix: add `@deprecated` tag to `slugs` document property #36

Closed angeloashmore closed 2 years ago

angeloashmore commented 2 years ago

Types of changes

Description

This PR adds a @deprecated tag to the slugs property on PrismicDocument.

Slugs are a deprecated featured used before the UID field was introduced. The property will continue to be included in the Rest API response, but usage should be discontinued and migrated to the UID field.

For more details on the slugs property and their deprecation decision, see: https://community.prismic.io/t/what-are-slugs/6493

Checklist:

🦤