Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
147 commits
Select commit Hold shift + click to select a range
0592d1c
Use beta logo
pwizla Mar 15, 2022
a09b7f2
Merge branch 'main' into next
derrickmehaffy Mar 15, 2022
f34d15c
[beta] Add TS command (#800)
soupette Mar 16, 2022
a1073a7
[beta] Dark mode: Updates user guide + dev docs (#795)
pwizla Mar 16, 2022
744d54a
Slightly update wording for TS flag
pwizla Mar 16, 2022
97b5f52
Update core store migration
pwizla Mar 16, 2022
0b5cea3
Added APP_KEYS to environmental variables table + fixed spelling error
stb13579 Mar 18, 2022
b5849fe
added link to middlewares documentation
stb13579 Mar 18, 2022
825fbe2
(WIP) Add permissions mapping tables
pwizla Mar 22, 2022
9b5f373
Fix typo
dsiddy Apr 3, 2022
893fbc6
Merge pull request #827 from dsiddy/patch-1
stb13579 Apr 4, 2022
861aa15
Added caution call out
stb13579 Apr 5, 2022
9efaeae
Updated the telemetry opt-out method
stb13579 Apr 5, 2022
1ad52cf
Update amazon-aws.md: Wrong package mentioned (#830)
spreadcharm Apr 5, 2022
9d662c5
Missing information for plugin creation #834
DimitriGilbert Apr 6, 2022
2d9e138
Include APP_KEYS in Heroku Deployment Guide
dsfaccini Apr 6, 2022
4ec63fc
Added caution callout and small text + formatting revisions
stb13579 Apr 8, 2022
906fb5d
Apply suggestions from code review
DimitriGilbert Apr 8, 2022
929c019
Merge pull request #831 from strapi/dev/telemetry-opt-out
stb13579 Apr 8, 2022
0c33ecd
Merge pull request #838 from dsfaccini/patch-1
stb13579 Apr 8, 2022
f2876ff
docs: improve the Laravel Documentation
Apr 8, 2022
12b3105
Merge pull request #836 from DimitriGilbert/patch-1
stb13579 Apr 8, 2022
e5651f5
docs: fix typo in code section
Apr 8, 2022
04c356b
Update azure.md
kulahad Apr 11, 2022
3b71421
Merge pull request #846 from kulahad/patch-1
stb13579 Apr 11, 2022
9f3c8ec
Merge pull request #843 from danielsum/patch-1
stb13579 Apr 11, 2022
58d8eb6
Finish adding permission mapping tables
pwizla Apr 12, 2022
a36afe7
Merge branch 'dev/next-sql-migration-updates'
pwizla Apr 12, 2022
4bf83e3
Merge branch 'production' into main
derrickmehaffy Apr 13, 2022
c5eb7e4
Remove typescript from production release
derrickmehaffy Apr 13, 2022
87a7001
Added migration guide
stb13579 Apr 19, 2022
f37dc7d
Added link to 4.1.8 migration guide
stb13579 Apr 19, 2022
208830a
add comments for Shaun
derrickmehaffy Apr 20, 2022
9e1198a
updated with Derrick's suggestions
stb13579 Apr 21, 2022
f949b2f
fixed spelling and phrasing
stb13579 Apr 21, 2022
1fea391
add JWT_SECRET code snippet
stb13579 Apr 21, 2022
b10d121
Fixed code for config/plugins
stb13579 Apr 21, 2022
48e9617
Update docs/developer-docs/latest/update-migration-guides/migration-g…
stb13579 Apr 21, 2022
ca702d0
Update docs/developer-docs/latest/update-migration-guides/migration-g…
stb13579 Apr 21, 2022
751757b
docs: fix typo (#853)
inc-ali Apr 21, 2022
8eeb915
Merge pull request #851 from strapi/dev/v4.1.8-migration
stb13579 Apr 21, 2022
44ea262
make render.com hosting guide work with strapi version >= v4.0.6 (#832)
NicoHof Apr 21, 2022
463e820
Add additional commands for Heroku environment variables config (#850)
derrickmehaffy Apr 21, 2022
491c601
Merge branch 'production' into main
derrickmehaffy Apr 21, 2022
5ce6da8
Fixed config object example code
mancku Apr 25, 2022
5d56315
remove API_TOKEN_SALT and APP_KEYS from env table
stb13579 Apr 25, 2022
f43441d
Merge pull request #805 from strapi/dev/env-update
stb13579 Apr 25, 2022
e9706ea
Merge pull request #859 from mancku/patch-1
stb13579 Apr 25, 2022
ed55fb6
Update routes.md
eliasleyton Apr 25, 2022
650cf1d
Merge pull request #860 from eliasleyton/patch-1
stb13579 Apr 25, 2022
bb43b7c
update link style
stb13579 Apr 26, 2022
6095196
updated migration guide to match template.
stb13579 Apr 27, 2022
c232bcd
Update docs/developer-docs/latest/update-migration-guides/migration-g…
stb13579 Apr 27, 2022
a9bd54d
Merge pull request #866 from strapi/dev/v4.1.8-migration
stb13579 Apr 27, 2022
c6a6a6d
[v4 migration] MongoDB additions to data migration guide (#818)
pwizla Apr 27, 2022
7a5149e
Lack one s in the file name middleware.js
slamer59 Apr 27, 2022
65f113b
Merge pull request #868 from slamer59/patch-1
stb13579 Apr 27, 2022
0def274
Merge pull request #828 from strapi/dev/Docker-update
stb13579 Apr 27, 2022
c63a2b1
Merge branch 'production' into main
derrickmehaffy Apr 27, 2022
bc3427e
Changed time based fields from snake case to camel case
kasonde May 3, 2022
a982168
docs: fixed command to start strapi (#870)
waznico May 3, 2022
e78f4cd
Update plugins-extension.md (#876)
rtalwar26 May 4, 2022
a1b31c8
fix: use correct key parameter for azure deploy (#874)
tefkah May 4, 2022
5af8275
Upload: improve code examples (#806)
gu-stav May 4, 2022
5935ad6
Update services.md (#880)
rtalwar26 May 6, 2022
a6a5cbd
Remove useless callout (#888)
pwizla May 10, 2022
e485b51
Force node 14 (#890)
derrickmehaffy May 10, 2022
53c5333
Update latest supported versions & expand docs (#883)
andrevitalb May 11, 2022
596e55b
Fix wrong wording in model information (#887)
pwizla May 11, 2022
cfaae3e
Add migration guide to 4.1.10 (#885)
petersg83 May 11, 2022
d76d4d0
Fix predefined hook's name. (#884)
kentarohorie May 11, 2022
cdf86b8
Strapi-maintained plugins descriptions (#833)
stb13579 May 11, 2022
cd4f8cb
Remove populateCreatorFields from models (#881)
stb13579 May 11, 2022
1c86ab9
Add NodeJS link to NODE_ENV=production (#879)
stb13579 May 11, 2022
fcffcd3
Fix the example code for registering hooks (#877)
pascalvaccaro May 11, 2022
7759647
Merge branch 'main' into production
pwizla May 11, 2022
59e173d
Update update-version.md
magnus-trent May 11, 2022
d3bf26d
typo
jbcrestot May 13, 2022
d22c018
Update services.md (#896)
alejandro-llanes May 16, 2022
4a9ad7f
Merge pull request #895 from jbcrestot/patch-1
stb13579 May 17, 2022
85f4798
Merge pull request #893 from TheGrimSilence/patch-1
stb13579 May 17, 2022
93ee4ec
Removed the getPlugin part for content-manager
kevinvugts May 17, 2022
6c50b59
Merge pull request #873 from strapi/fix/webhook_example
stb13579 May 17, 2022
d52bb20
Merge pull request #899 from kevinvugts/patch-1
stb13579 May 17, 2022
5eb3abf
Add caution call out to documentation plugin
stb13579 May 18, 2022
6b3e63b
Update docs/developer-docs/latest/plugins/documentation.md
stb13579 May 18, 2022
26d9014
Merge pull request #900 from strapi/dev/api-doc-plugin
stb13579 May 18, 2022
b2b24bd
Add caution callout above custom routes config (#901)
fdel-car May 20, 2022
0008937
docs typo (#871)
soldatovsh May 25, 2022
0751244
Configure last-updated plugin output (#905)
pwizla May 25, 2022
ff3c527
Replace logo with SVG version
pwizla May 30, 2022
306d572
Add 2x PNG logo
pwizla May 30, 2022
92c5932
Add a tip to content type schema migration page and link to Codemods …
tonoli May 30, 2022
8027bdd
Fix missing closing tip markup + improve wording
pwizla May 30, 2022
7c07de1
Improve wording further for codemods tip
pwizla May 30, 2022
7a14543
Update populating-fields.md (#913)
Benbinbin Jun 1, 2022
8cae88e
Update CONTRIBUTING.md
pwizla Jun 1, 2022
0bc1d3d
Update CONTRIBUTING.md
pwizla Jun 1, 2022
482e068
Update CONTRIBUTING.md
pwizla Jun 1, 2022
37fcaa4
Update CONTRIBUTING.md
pwizla Jun 1, 2022
888673e
Update CONTRIBUTING.md
pwizla Jun 1, 2022
5bceef4
Update CONTRIBUTING.md
pwizla Jun 1, 2022
48bf45b
Update CONTRIBUTING.md
pwizla Jun 1, 2022
c42b470
Merge branch 'production' of github.com:strapi/documentation into pro…
pwizla Jun 1, 2022
251b4a9
Fix typo
derrickmehaffy Jun 1, 2022
c167418
Fix 404 on migration guides
pwizla Jun 1, 2022
cce4830
Merge branch 'main' of github.com:strapi/documentation
pwizla Jun 1, 2022
1be3dc3
Merge branch 'production' of github.com:strapi/documentation into pro…
pwizla Jun 1, 2022
fe7976d
Update node versions
pwizla Jun 13, 2022
90f28fc
typo in Collection by Field section (#927)
j0hnskot Jun 13, 2022
14f369b
Fix upload example for Node.js (#908)
arslan Jun 13, 2022
39e1123
Update 11ty.md with Strapi v4 (#909)
ggirou Jun 13, 2022
5c52f8c
Update Autocreate Slug with Lifecycles (#910)
derschiw Jun 13, 2022
39ea19d
Fix middleware structure
pwizla Jun 13, 2022
8ca9559
Add missing acquireConnectionTimeout config option to database (#929)
derrickmehaffy Jun 14, 2022
8eb2088
Release 4.2.0 to staging (#933)
pwizla Jun 15, 2022
52e11f6
Remove TypeScript code snippets from DigitalOcean deployment guide (#…
stb13579 Jun 15, 2022
56c31d0
Update Marketplace-v4.png (#941)
gpene Jun 15, 2022
3c59e4c
Fix upload code example
pwizla Jun 15, 2022
4058944
Fix code example in upload.md
pwizla Jun 15, 2022
bf1b036
Merge branch 'main' of github.com:strapi/documentation
pwizla Jun 15, 2022
5de63a8
Merge branch 'production' of github.com:strapi/documentation into pro…
pwizla Jun 15, 2022
539141c
Merge branch 'production'
pwizla Jun 15, 2022
ef83549
Add caution callout about dynamic zones (#949)
pwizla Jun 16, 2022
38fd351
fix typo (#943)
stb13579 Jun 16, 2022
3ce821e
Fix aws-s3 provider code snippet to avoid ACL public-read access issu…
pwizla Jun 17, 2022
dec9a46
Document how to access a plugin configuration (#955)
pwizla Jun 17, 2022
884b024
Reference Entity Service API from Server API for plugins (#956)
pwizla Jun 17, 2022
ea08f9c
Explain Entity Service vs. Query Engine + document knex access (#953)
pwizla Jun 20, 2022
e3e6ce9
add 2nd connection property for managed db connection (#948)
stb13579 Jun 20, 2022
5dfa28c
typo fix (#960)
AlexMNet Jun 20, 2022
f61f868
fix typo in page Slug System (#958)
tvqqq Jun 21, 2022
c81b678
Updated documentation to support Strapi v4 (#701)
juliangra Jun 21, 2022
fc9d93c
Mention StoryBook link in Admin Panel customization (#962)
pwizla Jun 21, 2022
97a0f11
Add FAQ entry about serverless environments (#959)
pwizla Jun 23, 2022
1416722
Contributing: Add instructions on how to run the project (#968)
gu-stav Jun 24, 2022
56e65b1
Environment: add docs for `FAST_REFRESH` (#970)
gu-stav Jun 24, 2022
f6a08f4
Remove "pending repoduction" label
pwizla Jun 27, 2022
f8e6200
Merge branch 'production'
pwizla Jun 27, 2022
2b6876d
Various REST API improvements (#761)
meganelacheny Jun 28, 2022
c5f6f72
Update for installed providers (#976)
gpene Jun 29, 2022
c9f3cab
🧐 Release 4.2.1 to staging (#972)
pwizla Jun 29, 2022
e19c997
Use a more precise link for plugin install instructions
pwizla Jun 29, 2022
bde813f
Fix numbers in procedure
pwizla Jun 29, 2022
8600289
Fix broken links
pwizla Jun 29, 2022
63edaf9
Add missing default value for defaultLimit GraphQL config.
pwizla Jun 29, 2022
ded1f9f
Bump to 4.2.2
pwizla Jun 29, 2022
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Documentation Bug Report
description: Create a report to help us improve the Strapi documentation.
title: "[Bug]: "
labels: "type: bug, status: pending reproduction"
labels: "type: bug"
body:
- type: input
attributes:
Expand Down
23 changes: 22 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,28 @@ Follow the procedure below to contribute to the Strapi documentation.
git checkout -b <user/branch-name>

```


7. Run the docs on your computer

```bash
cd docs

# Install dependencies
yarn

# Run user and developer-docs
yarn dev

# Run developer-docs only
yarn dev:dev

# Run user-docs only
yarn dev:user

```

The project is now up and running at http://localhost:8080 and you should be able to access it in your browser.


You are now ready to contribute to the Strapi documentation! 🚀

Expand Down
10 changes: 4 additions & 6 deletions docs/.vuepress/config/sidebar-developer.js
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,12 @@ const developer = [
path: '/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html',
collapsable: true,
initialOpenGroupIndex: -1,
// sidebarDepth: 3,
sidebarDepth: 3,
children: [
['/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html', 'API endpoints'],
{
title: 'API Parameters',
title: 'API parameters',
path: '/developer-docs/latest/developer-resources/database-apis-reference/rest/api-parameters.html',
collapsable: true,
initialOpenGroupIndex: -1,
children: [
Expand All @@ -261,10 +263,6 @@ const developer = [
],
]
},
[
'/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html',
'API Endpoints'
]
],
},
[
Expand Down
4 changes: 4 additions & 0 deletions docs/.vuepress/styles/strapi-custom-blocks.styl
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@
color: rgba(241,251,255,.8)
p
padding-left: 1rem
code
/* Chrome version 29 and above */
@media screen and (-webkit-min-device-pixel-ratio:0) and (min-resolution:.001dpcm)
word-break: break-word
ul, ol
padding-left: 3rem
[class^="language-"]
Expand Down
16 changes: 16 additions & 0 deletions docs/developer-docs/latest/developer-resources/cli/CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,22 @@ options [--delete-files]
Some plugins have admin panel integrations, your admin panel might have to be rebuilt. This can take some time.
:::

## strapi telemetry:disable

Disable data collection for the project (see [Usage Information](/developer-docs/latest/getting-started/usage-information.md)).

```bash
strapi telemetry:disable
```

## strapi telemetry:enable

Re-enable data collection for the project after it was disabled (see [Usage Information](/developer-docs/latest/getting-started/usage-information.md)).

```bash
strapi telemetry:enable
```

## strapi console

Start the server and eval commands in your application in real time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In case you want to connect a React application with Strapi, we say that React i

If your Strapi application contains restaurants and you want to list them in your React application, all you need to do is to make an HTTP request to Strapi which will take care to give you a response containing your restaurants.

The [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints) documentation will give you all the keys in hand to interact with your Strapi API.
The [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints) documentation will give you all the keys in hand to interact with your Strapi API.

## Get started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,4 +316,4 @@ void main() {

## Conclusion

Here is how to request your collection types in Strapi using Dart. When you create a collection type or a single type you will have a certain number of [REST API endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints) available to interact with.
Here is how to request your collection types in Strapi using Dart. When you create a collection type or a single type you will have a certain number of [REST API endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints) available to interact with.
Original file line number Diff line number Diff line change
Expand Up @@ -217,4 +217,4 @@ var response = await http.put(

## Conclusion

Here is how to request your collection types in Strapi using Dart/Flutter. When you create a collections type or a single type you will have a certain number of [REST API endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints) available to interact with.
Here is how to request your collection types in Strapi using Dart/Flutter. When you create a collections type or a single type you will have a certain number of [REST API endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints) available to interact with.
Original file line number Diff line number Diff line change
Expand Up @@ -318,4 +318,4 @@ func putD() {

Here is how to request your collection types in Strapi using Go. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -640,4 +640,4 @@ fetch('http://localhost:1337/api/restaurants/2', {

Here is how to request your collection types in Strapi using Next.js. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -780,4 +780,4 @@ fetch('http://localhost:1337/api/restaurants/2', {

Here is how to request your collection types in Strapi using Nuxt.js. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -442,4 +442,4 @@ postRestaurantWithAuth($jwt);

Here is how to request your collection types in Strapi using PHP. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -639,4 +639,4 @@ fetch('http://localhost:1337/api/restaurants/2', {

Here is how to request your collection types in Strapi using React. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -582,4 +582,4 @@ fetch('http://localhost:1337/api/restaurants/2', {

Here is how to request your collection types in Strapi using Vue.js. When you create a collection type or a single type you will have a certain number of REST API endpoints available to interact with.

We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#api-endpoints).
We just used the GET, POST and PUT methods here but you can [get one entry](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#get-an-entry), and [delete](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#delete-an-entry) an entry too. Learn more about [API Endpoints](/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md#endpoints).
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/d

Strapi provides an Entity Service API, built on top of the [Query Engine API](/developer-docs/latest/developer-resources/database-apis-reference/query-engine-api.md). The Entity Service is the layer that handles Strapi's complex data structures like [components](/developer-docs/latest/development/backend-customization/models.md#components) and [dynamic zones](/developer-docs/latest/development/backend-customization/models.md#dynamic-zones), and uses the Query Engine API under the hood to execute database queries.

::: strapi Entity Service API vs. Query Engine API
!!!include(developer-docs/latest/developer-resources/database-apis-reference/snippets/entity-query-knex-callout.md)!!!
:::

## Basic usage

The Entity Service is available through `strapi.entityService`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/d

# Query Engine API

Strapi provides a Query Engine API to interact with the database layer at a lower level. It should mostly be used by plugin developers and developers adding custom business logic to their applications.
Strapi provides a Query Engine API to interact with the database layer at a lower level. It should mostly be used by plugin developers and developers adding custom business logic to their applications. In most use cases, it's recommended to use the [Entity Service API](/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.md) instead.

Strapi's Query Engine API gives unrestricted internal access to the database layer. It is not aware of the complex data structures like components and dynamic zones, as opposed to the [Entity Service API](/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.md).
::: strapi Entity Service API vs. Query Engine API
!!!include(developer-docs/latest/developer-resources/database-apis-reference/snippets/entity-query-knex-callout.md)!!!
:::

## Basic usage

Expand Down
Loading