6 Commits

Author SHA1 Message Date
Riley Shea
4f2ded3c53
Erroneous double quote syntax error (#6257)
Erroneous double quote in custom  extensions/documentation/config/settings.json example
2020-05-25 18:33:09 +02:00
Ralph
dae9cfa415
Make plugins documentation generation optional (#5465)
* Make plugins documentation generation optional

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

* Removing "-" character from schema names for generated plugin documentation so it becomes compatible with AWS API gateway import API feature using OAS file. Adding only one property to the settings file pluginsForWhichToGenerateDoc so that the user can choose for which plugin he wishes to generate documentation. Adding a parameter to generate or not the default response (this can now be set to false to have a documentation that is compatible with AWS API Gateway).

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

* Updating settings.json to start without the pluginsForWhichToGenerateDoc key so that all plugins documentation gets generated by default. Updated the documentation to reflect this change.

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

* Updating documentation to correct typos and rephrase some sentences to make them more clear.

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

* Destructuring the config to the var pluginsForWhichToGenerateDoc instead of renaming it to take into account comment from Alexandre Bodin

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

* Destructuring generateDefaultResponse and pluginsForWhichToGenerateDoc from strapi config object based on feedback from Alexandre Bodin

Signed-off-by: Ralph Maroun <rmaroun@outlook.com>

Co-authored-by: Alexandre BODIN <alexandrebodin@users.noreply.github.com>
2020-03-20 14:03:51 +01:00
Jim LAURIE
1dabca7fe2
Merge branch 'master' into docs-vuepress-v1 2019-11-20 19:05:43 +01:00
Pierre-Alexandre
88f6b675ff valid JSON makes a working example (#4552) 2019-11-20 11:55:56 +01:00
Jim LAURIE
74b0f2e11e Update files dir 2019-11-07 12:05:39 +01:00
Jim LAURIE
75dfd95946 Move the documentation plugin in a plugins section 2019-10-03 17:28:37 +02:00