Strapi v4.0.3 release - Docs (#639)

* 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)

* Add information about uid and remove model name for upload ref (#614)

* Update server.md (#598)

* Update i18n docs, fix locale filter typo + autoformat (#609)

* Update email.md (#611)

Link to correct sendgrid npm

* Fix wrong strapi module name for server.js (#615)

Signed-off-by: harimkims <[email protected]>

* easy syntax corrections in entity-service/crud (#620)

* easy syntax correction. should be api:: with double colon

* fix typo in entity service example

* fix some of the broken links (#626)

* Fix typo in configuration options (#619)

Configuration options for toggling tutorials on or off and
notifying about new releases contained a typo referencing
"tutorial" key instead of "tutorials" and "notification.release"
instead of "notification.releases"

* entityService/populate updates to v4 (#621)

* entityService is not function

* add await to entityService

* some changes entity-service/populate

* Update entity-service/populate.md

Co-authored-by: DMehaffy <[email protected]>

* Update populate.md

Co-authored-by: DMehaffy <[email protected]>

* typos (#628)

* Update upload.md (#616)

Typo in "middleware"

* Fixed content type export object & missing commas (#627)

Without { schema } don`t work( I use v4.0.2
In another plugin:
https://github.com/strapi/strapi/blob/master/packages/plugins/users-permissions/server/content-types/index.js

* fix(dev/docs): typo `intLabel` to `intlLabel` (#625)

* Update services.md (#632)

* Update services.md

* Update services.md

* Fix link formatting in v4 REST API

* remove clean flag from build commands (#623)

* Update docs/developer-docs/latest/concepts/draft-and-publish.md

Co-authored-by: Pierre Wizla <[email protected]>

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]>
Co-authored-by: Richard Nsama <[email protected]>
Co-authored-by: Stefano <[email protected]>
Co-authored-by: Jean-Sébastien Herbaux <[email protected]>
Co-authored-by: Francesco Bianchi <[email protected]>
Co-authored-by: Sharsie <[email protected]>
Co-authored-by: sunnyson <[email protected]>
Co-authored-by: Jozef Culen <[email protected]>
Co-authored-by: Yagor Shtonda <[email protected]>
Co-authored-by: Gaurav Sharma <[email protected]>
Co-authored-by: Muhammad Umair Irshad <[email protected]>

Author: 26 people

docs/developer-docs/latest/concepts/draft-and-publish.md

@@ -10,7 +10,7 @@ The draft and publish feature allows you to save your content as a draft, to pub
 
 ## Activating or deactivating the draft and publish feature
 
-By default, the draft and publish feature is activated for all newly created collection and single types. It is however possible to deactivate the feature at content type level (i.e. it can be activated for one content type, but deactivated for another).
+By default, the draft and publish feature is enabled for all newly created collection and single types. It is however possible to disable the feature at the content-type level (i.e. it can be enabled for one content type, but disabled for another).
 
 ::: warning
 If the feature is deactivated while contents are saved as drafts, they will automatically be deleted. Make sure all contents are published before deactivating the feature.

docs/developer-docs/latest/developer-resources/cli/CLI.md

@@ -90,8 +90,6 @@ options: [--no-optimization]
 ```
 
 - **strapi build**<br/>
-  Builds the administration panel and minimizing the assets
-- **strapi build --clean**<br/>
   Builds the administration panel and delete the previous build and .cache folders
 - **strapi build --no-optimization**<br/>
   Builds the administration panel without minimizing the assets. The build duration is faster.

docs/developer-docs/latest/developer-resources/database-apis-reference/rest-api.md

@@ -9,7 +9,7 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/d
 
 The REST API allows accessing the [content-types](/developer-docs/latest/development/backend-customization/models.md#content-types) through API endpoints that Strapi automatically creates.
 
-[API parameters](#api-parameters) can be used to [filter](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#filtering), [sort](/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md#sorting), and [paginate](/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md#pagination) results and to [select fields](/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md#field-selection) and relations to [populate](/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md#population)). Additionally, specific parameters related to optional Strapi features can be used, like [publication state](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#publication-state) and [locale](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#locale.
+[API parameters](#api-parameters) can be used to [filter](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#filtering), [sort](/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md#sorting), and [paginate](/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.md#pagination) results and to [select fields](/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md#field-selection) and relations to [populate](/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.md#population)). Additionally, specific parameters related to optional Strapi features can be used, like [publication state](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#publication-state) and [locale](/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.md#locale).
 
 ## API Parameters
 

docs/developer-docs/latest/developer-resources/plugin-api-reference/admin-panel.md

@@ -290,7 +290,7 @@ export default {
 	   { id: String, intlLabel: { id: String, defaultMessage: String }, // Section to create
 		 [ // links
 			 {
-			   intLabel: { id: String, defaultMessage: String },
+			   intlLabel: { id: String, defaultMessage: String },
 			   id: String,
 			   to: String,
 			   Component: myComponent,
@@ -325,7 +325,7 @@ export default {
 		app.addSettingsLink(
 		 'global', // id of the section to add the link to
 			{
-				intLabel: { id: String, defaultMessage: String },
+				intlLabel: { id: String, defaultMessage: String },
 				id: String,
 				to: String,
 				Component: myComponent,
@@ -361,7 +361,7 @@ export default {
     app.addSettingsLinks(
       'global', // id of the section to add the link in
         [{
-          intLabel: { id: String, defaultMessage: String },
+          intlLabel: { id: String, defaultMessage: String },
           id: String,
           to: String,
           Component: myComponent,

docs/developer-docs/latest/developer-resources/plugin-api-reference/server.md

@@ -141,8 +141,8 @@ const contentTypeA = require('./content-type-a');
 const contentTypeB = require('./content-type-b');
 
 module.exports = {
-  'content-type-a': contentTypeA, // should re-use the singularName of the content-type
-  'content-type-b': contentTypeB, 
+  'content-type-a': { schema: contentTypeA }, // should re-use the singularName of the content-type
+  'content-type-b': { schema: contentTypeB },
 };
 ```
 
@@ -156,25 +156,25 @@ module.exports = {
     pluralName: 'content-type-as', // kebab-case mandatory
     displayName: 'Content Type A',
     description: 'A regular content type',
-    kind: 'collectionType'
+    kind: 'collectionType',
   },
   options: {
     draftAndPublish: true,
   },
   pluginOptions: {
     'content-manager': {
-      visible: false
+      visible: false,
     },
     'content-type-builder': {
-      visible: false
+      visible: false,
     }
   },
   attributes: {
     name: {
       type: 'string',
       min: 1,
       max: 50,
-      configurable: false
+      configurable: false,
     },
   }
 };
@@ -195,7 +195,7 @@ const routes = require('./routes');
 
 module.exports = () => ({
   routes,
-  type: 'content-api' // can also be 'admin-api' depending on the type of route
+  type: 'content-api', // can also be 'admin-api' depending on the type of route
 });
 ```
 

docs/developer-docs/latest/development/backend-customization/services.md

@@ -58,7 +58,7 @@ module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) =>
   async findOne(entityId, params = {}) {
     return strapi.entityService.findOne('api::restaurant.restaurant', entityId, this.getFetchParams(params));
   }
-});
+}));
 ```
 
 ::: strapi Entity Service API
@@ -97,7 +97,7 @@ module.exports = createCoreService('api::restaurant.restaurant', ({ strapi }) =>
     // Return a promise of the function that sends the email.
     return transporter.sendMail(options);
   },
-});
+}));
 ```
 
 The service is now available through the `strapi.service('api::email.email').send(...args)` global variable. It can be used in another part of the codebase, like in the following controller:
@@ -121,7 +121,7 @@ module.exports = createCoreController('api::restaurant.restaurant', ({ strapi })
       ok: true,
     });
   },
-});
+}));
 ```
 
 ::::

docs/developer-docs/latest/update-migration-guides/update-version.md

@@ -79,13 +79,13 @@ Rebuild the admin panel with one of the following commands:
 
 <code-block title="NPM">
 ```sh
-npm run build -- --clean
+npm run build
 ```
 </code-block>
 
 <code-block title="YARN">
 ```sh
-yarn build --clean
+yarn build
 ```
 </code-block>