Skip to content

Document locale parameter for Entity Service CRUD #3147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pwizla merged 1 commit into from
May 11, 2026
+5 −0
Merged

Document locale parameter for Entity Service CRUD #3147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docusaurus/docs/cms/api/entity-service/crud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Syntax: `findOne(uid: string, id: ID, parameters: Params)` ⇒ `Entry`
| ---------- | --------------- | --------------- |
| `fields` | Attributes to return | `String[]` |
| `populate` | Relations, components and dynamic zones to [populate](/cms/api/entity-service/populate) | [`PopulateParameter`](/cms/api/entity-service/populate) |
| `locale` | Locale code (for example `fr-FR`) when the Internationalization plugin is enabled. Targets the localized variant instead of the default locale. | `string` |

### Example

Expand Down Expand Up @@ -64,6 +65,7 @@ Syntax: `findMany(uid: string, parameters: Params)` ⇒ `Entry[]`
| `sort` | [Order](/cms/api/entity-service/order-pagination) definition | [`OrderByParameter`](/cms/api/entity-service/order-pagination) |
| `populate` | Relations, components and dynamic zones to [populate](/cms/api/entity-service/populate) | [`PopulateParameter`](/cms/api/entity-service/populate) |
| `publicationState` | Publication state, can be:<ul><li>`live` to return only published entries</li><li>`preview` to return both draft entries & published entries (default)</li></ul> | `PublicationStateParameter` |
| `locale` | Locale code when the Internationalization plugin is enabled. Restricts results to that locale (omit for the default locale). | `string` |

### Example

Expand Down Expand Up @@ -105,6 +107,7 @@ Syntax: `create(uid: string, parameters: Params)` ⇒ `Entry`
| ---------- | ----------- | ---------- |
| `fields` | Attributes to return | `String[]` |
| `populate` | Relations, components and dynamic zones to [populate](/cms/api/entity-service/populate) | [`PopulateParameter`](/cms/api/entity-service/populate) |
| `locale` | Locale code when the Internationalization plugin is enabled. Creates the entry for that locale. | `string` |
| `data` | Input data | `Object` |

<ManagingRelations components={props.components} />
Expand Down Expand Up @@ -137,6 +140,7 @@ Syntax: `update(uid: string, id: ID, parameters: Params)` ⇒ `Entry`
| ---------- | ------------- | ---------- |
| `fields` | Attributes to return | `String[]` |
| `populate` | Relations, components and dynamic zones to [populate](/cms/api/entity-service/populate) | [`PopulateParameter`](/cms/api/entity-service/populate) |
| `locale` | Locale code when the Internationalization plugin is enabled. Updates the matching localized variant. | `string` |
| `data` | Input data | `object` |

### Example
Expand All @@ -161,6 +165,7 @@ Syntax: `delete(uid: string, id: ID, parameters: Params)` ⇒ `Entry`
| ---------- | --------- | -------- |
| `fields` | Attributes to return | `String[]` |
| `populate` | Relations, components and dynamic zones to [populate](/cms/api/entity-service/populate) | [`PopulateParameter`](/cms/api/entity-service/populate) |
| `locale` | Locale code when the Internationalization plugin is enabled. Deletes the localized variant that matches this locale. | `string` |

### Example

Expand Down
Loading