Skip to content

Update examples in service concept #99

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
merged 5 commits into from
Feb 8, 2021
Merged

Update examples in service concept #99

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dce2eeb
Add isDraft to validateEntity in service examples
Feb 3, 2021
ebda76d
Merge remote-tracking branch 'strapi/main' into concepts/services
Feb 3, 2021
fc27188
Merge branch 'main' into concepts/services
derrickmehaffy Feb 5, 2021
4566f8f
Fix typo services.md
MattieBelt Feb 8, 2021
447b2df
Merge branch 'main' into concepts/services
MattieBelt Feb 8, 2021
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
32 changes: 29 additions & 3 deletions developer-docs/latest/concepts/services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ You can read about `strapi.query` calls [here](./queries.md).
In the following example your controller, service and model are named `restaurant`.
:::

#### Utils

If you're extending the `create` or `update` service, first require the following utility function:

```js
const { isDraft } = require('strapi-utils').contentTypes;
```

- `isDraft`: This function checks if the entry is a draft.


#### Collection Type

:::: tabs
Expand Down Expand Up @@ -131,6 +142,8 @@ module.exports = {
#### `create`

```js
const { isDraft } = require('strapi-utils').contentTypes;

module.exports = {
/**
* Promise to add record
Expand All @@ -139,7 +152,13 @@ module.exports = {
*/

async create(data, { files } = {}) {
const validData = await strapi.entityValidator.validateEntityCreation(strapi.models.restaurant, data);
const isDraft = isDraft(data, strapi.models.restaurant);
const validData = await strapi.entityValidator.validateEntityCreation(
strapi.models.restaurant,
data,
{ isDraft }
);

const entry = await strapi.query('restaurant').create(validData);

if (files) {
Expand All @@ -163,6 +182,8 @@ module.exports = {
#### `update`

```js
const { isDraft } = require('strapi-utils').contentTypes;

module.exports = {
/**
* Promise to edit record
Expand All @@ -171,10 +192,15 @@ module.exports = {
*/

async update(params, data, { files } = {}) {
const existingEntry = await db.query('restaurant').findOne(params);

const isDraft = isDraft(existingEntry, strapi.models.restaurant);
const validData = await strapi.entityValidator.validateEntityUpdate(
strapi.models.restaurant,
data
strapi.models.restaurant,
data,
{ isDraft }
);

const entry = await strapi.query('restaurant').update(params, validData);

if (files) {
Expand Down