Skip to content

Commit f6db32a

Browse files
derrickmehaffyazulkiplialexkainzingerGeoFropwizla
authored
Deploy: Christmas time release (#606)
* auth route v4 (#553) i found that default authentication route should be `/api/auth/local` * fix: typo in backend-customization/middlewares.md (#557) * Update i18n.md (#564) Co-authored-by: Pierre Wizla <[email protected]> * Added API suffix (#556) Co-authored-by: Pierre Wizla <[email protected]> * fix wrong uid (#558) Signed-off-by: harimkims <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * default route user register in v4 (#554) I found that default route user register in v4 is `api/auth/local/register` Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix remaining localhost links (#568) * Fix wrong syntax in GraphQL plugin docs (#537) Signed-off-by: harimkims <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix wrong parameter name in connection.connection (#559) In the documentation about the connection parameters, the `username` parameter does not actually exist. This is probably a typo and should be replaced by the `user` parameter as per the example given below on the same page. Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix broken links in GraphQL & i18n (#583) * Update default MySQL Port (#575) Update default MySQL Port in example to 3306 Co-authored-by: Pierre Wizla <[email protected]> * Add closing parenthesis to predefined hook code example (#589) * 📖 ⬆️ bump Mysql/MariaDB minimum verison (#593) - bump MyQL/MariaDB Minimum Version for `JSON` datatype support * Update controllers.md (#586) There should be two enclosing parenthesis at the end. Co-authored-by: Pierre Wizla <[email protected]> * Fix config example for GraphQL (#591) Co-authored-by: Pierre Wizla <[email protected]> * docs: One-to-One should use singular in example (#570) Co-authored-by: Pierre Wizla <[email protected]> * Remaining auth v4 changes (#565) There are still some references to the v3 auth endpoints (without `/api` at the start) on the Users and Permissions plugin documentation. # What does it do? Updates Strapi endpoints to include `/api` at the start # Why is it needed? This change should be documented; it caused a lot of confusion for me as I was trying to figure out why my authentication was not working on v4. # Related issue(s)/PR(s) A similar thing was fixed for the guides in PR #553 Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: DMehaffy <[email protected]> * lifecycles.js file is not generated automatically (#566) * lifecycles.js file is not generated automatically I think since version 4, the lifecycles.js file is not created automatically but needs to be created manually, if needed. Postscript Correct me if I'm wrong. You can also rephrase this change if it is relevant and true. Thanks * Update docs/developer-docs/latest/development/backend-customization/models.md Co-authored-by: DMehaffy <[email protected]> * Update docs/developer-docs/latest/development/backend-customization/models.md Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: DMehaffy <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Rewrite REST examples to use QS + Misc fixes (#541) * WIP rewriting REST guide * Fix example * rewrite filtering and init the other two * move to request/response instead * remove an example and fix typo * remove another example based on community feedback * add missing $and and $or * 99% finished with filtering * wip population * Try adding some GitHub Actions to check links * fix syntax error in tests file * Force working directory * change to only pull request * Fix publicationState and add field selection * Add relation population examples * Add component exmple * basic dynamic zone example, need a more complex one too Need to talk to engineering about more complex example * Finished rewriting REST docs Just need to clean up left menu * Fix broken links * Fix missing commas in examples * Fix all non-uniform uses of `// ...` Yes I was bored af * fix example response syntax error * Fix extra data comments * remove workflow from this PR move to #574 * pr feedback 1 * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Apply suggestions from code review Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md Co-authored-by: Pierre Wizla <[email protected]> * tweak menu + other fixes Co-authored-by: Pierre Wizla <[email protected]> * Corrected: Database.js Structure and key variable (#603) The default structure provided in the doc doesn't work on AWS. The provided syntax which has connection object within connection object which consists of configurations seems to work. username key is being replaced with user * Change strapi.api example from function to array (#539) Co-authored-by: azulkipli <[email protected]> Co-authored-by: Alexander Kainzinger <[email protected]> Co-authored-by: George F <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Precious Luke <[email protected]> Co-authored-by: Kim, Harim <[email protected]> Co-authored-by: Camille Briand <[email protected]> Co-authored-by: Adam Miedema <[email protected]> Co-authored-by: YoRolling <[email protected]> Co-authored-by: Zeeshan Tariq <[email protected]> Co-authored-by: smoothdvd <[email protected]> Co-authored-by: arielbk <[email protected]> Co-authored-by: Adiel Ben Moshe <[email protected]> Co-authored-by: Shubam Virdi <[email protected]> Co-authored-by: cvermand <[email protected]>
1 parent d08371e commit f6db32a

File tree

23 files changed

+1323
-442
lines changed

23 files changed

+1323
-442
lines changed

‎docs/.vuepress/config.js‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -228,12 +228,41 @@ const sidebar = {
228228
{
229229
title: 'APIs Reference',
230230
collapsable: true,
231+
initialOpenGroupIndex: -1,
231232
sidebarDepth: 1,
232233
children: [
233-
[
234-
'/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md',
235-
'REST API',
236-
],
234+
{
235+
title: 'REST API',
236+
path: '/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html',
237+
collapsable: true,
238+
initialOpenGroupIndex: -1,
239+
// sidebarDepth: 3,
240+
children: [
241+
{
242+
title: 'API Parameters',
243+
collapsable: true,
244+
initialOpenGroupIndex: -1,
245+
children: [
246+
[
247+
'/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md',
248+
'Filtering, Locale, and Publication State'
249+
],
250+
[
251+
'/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md',
252+
'Population & Field Selection'
253+
],
254+
[
255+
'/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md',
256+
'Sort & Pagination'
257+
],
258+
]
259+
},
260+
[
261+
'/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html',
262+
'API Endpoints'
263+
]
264+
],
265+
},
237266
[
238267
'/developer-docs/latest/developer-resources/database-apis-reference/graphql-api.md',
239268
'GraphQL API',

‎docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/d
66

77
# Entity Service API
88

9-
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-2) 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.
9+
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.
1010

1111
## Basic usage
1212

‎docs/developer-docs/latest/developer-resources/database-apis-reference/entity-service/components-dynamic-zones.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/d
66

77
# Entity Service API: Components and dynamic zones
88

9-
The [Entity Service](/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.md) is the layer that handles [components](/developer-docs/latest/development/backend-customization/models.md#components-2) and [dynamic zones](/developer-docs/latest/development/backend-customization/models.md#dynamic-zones) logic. With the Entity Service API, components and dynamic zones can be [created](#creation) and [updated](#update) while creating or updating entries.
9+
The [Entity Service](/developer-docs/latest/developer-resources/database-apis-reference/entity-service-api.md) is the layer that handles [components](/developer-docs/latest/development/backend-customization/models.md#components) and [dynamic zones](/developer-docs/latest/development/backend-customization/models.md#dynamic-zones) logic. With the Entity Service API, components and dynamic zones can be [created](#creation) and [updated](#update) while creating or updating entries.
1010

1111
## Creation
1212

13-
A [component](/developer-docs/latest/development/backend-customization/models.md#components-2) can be created while creating an entry with the Entity Service API:
13+
A [component](/developer-docs/latest/development/backend-customization/models.md#components) can be created while creating an entry with the Entity Service API:
1414

1515
```js
1616
strapi.entityService.create('api::article.article', {
@@ -43,7 +43,7 @@ strapi.entityService.create('api::article.article', {
4343

4444
## Update
4545

46-
A [component](/developer-docs/latest/development/backend-customization/models.md#components-2) can be updated while updating an entry with the Entity Service API. If a component `id` is specified, the component is updated, otherwise the old one is deleted and a new one is created:
46+
A [component](/developer-docs/latest/development/backend-customization/models.md#components) can be updated while updating an entry with the Entity Service API. If a component `id` is specified, the component is updated, otherwise the old one is deleted and a new one is created:
4747

4848
```js
4949
strapi.entityService.update('api::article.article', 1, {

0 commit comments

Comments
 (0)