strapi / documentation

Strapi Documentation
https://docs.strapi.io
Other
1.02k stars 1.11k forks source link

entityService parameter documentation should include 'locale' #2110

Open bart-iimpcoll opened 5 months ago

bart-iimpcoll commented 5 months ago

Link to the documentation page or resource

https://docs.strapi.io/dev-docs/api/entity-service/crud

Describe the bug

On the page https://docs.strapi.io/dev-docs/api/entity-service/crud are only fields and filters and populate mentioned. There is a parameter 'locale' that I needed to use to retrieve non-default entries, but it's not mentioned anywhere in the entityService documentation as far as I can tell. I found it by trial and error.

Additional context

No response

Suggested improvements or fixes

Please add all possible entityService parameters to the documentation to make it easier for others to use

Related issue(s)/PR(s)

No response

pwizla commented 3 months ago

Thanks for the suggestion, @bart-iimpcoll. We'll see what we can do. Right now we are focused on polishing Strapi 5 documentation.

I would, by the way, recommend that you prepare yourself to transition to the Document Service API which will replace the Entity Service API in Strapi 5.

See https://docs-next.strapi.io/dev-docs/api/document-service for more details. You will be happy to notice that use cases with locale are much more extensively documented with the Document Service API 😊