@strapi/plugin-documentation 0.0.0-02af04644a1b236c1add59b27e2da1cfd7843fc5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/README.md +151 -0
- package/__mocks__/strapi.js +41 -0
- package/__tests__/build-component-schema.test.js +271 -0
- package/admin/src/components/FieldActionWrapper/index.js +14 -0
- package/admin/src/components/PluginIcon/index.js +12 -0
- package/admin/src/index.js +80 -0
- package/admin/src/pages/PluginPage/index.js +199 -0
- package/admin/src/pages/PluginPage/tests/index.test.js +873 -0
- package/admin/src/pages/PluginPage/tests/server.js +23 -0
- package/admin/src/pages/SettingsPage/index.js +181 -0
- package/admin/src/pages/SettingsPage/tests/index.test.js +612 -0
- package/admin/src/pages/SettingsPage/tests/server.js +18 -0
- package/admin/src/pages/utils/api.js +31 -0
- package/admin/src/pages/utils/schema.js +11 -0
- package/admin/src/pages/utils/useReactQuery.js +46 -0
- package/admin/src/permissions.js +19 -0
- package/admin/src/pluginId.js +5 -0
- package/admin/src/translations/ar.json +20 -0
- package/admin/src/translations/cs.json +21 -0
- package/admin/src/translations/de.json +26 -0
- package/admin/src/translations/dk.json +39 -0
- package/admin/src/translations/en.json +39 -0
- package/admin/src/translations/es.json +39 -0
- package/admin/src/translations/fr.json +26 -0
- package/admin/src/translations/id.json +24 -0
- package/admin/src/translations/it.json +26 -0
- package/admin/src/translations/ko.json +39 -0
- package/admin/src/translations/ms.json +23 -0
- package/admin/src/translations/nl.json +21 -0
- package/admin/src/translations/pl.json +39 -0
- package/admin/src/translations/pt-BR.json +21 -0
- package/admin/src/translations/pt.json +21 -0
- package/admin/src/translations/ru.json +28 -0
- package/admin/src/translations/sk.json +24 -0
- package/admin/src/translations/th.json +24 -0
- package/admin/src/translations/tr.json +20 -0
- package/admin/src/translations/uk.json +23 -0
- package/admin/src/translations/vi.json +24 -0
- package/admin/src/translations/zh-Hans.json +28 -0
- package/admin/src/translations/zh.json +24 -0
- package/admin/src/utils/getTrad.js +5 -0
- package/admin/src/utils/index.js +2 -0
- package/admin/src/utils/openWithNewTab.js +20 -0
- package/package.json +66 -0
- package/server/bootstrap.js +54 -0
- package/server/config/default-plugin-config.js +74 -0
- package/server/config/index.js +7 -0
- package/server/controllers/documentation.js +241 -0
- package/server/controllers/index.js +7 -0
- package/server/index.js +17 -0
- package/server/middlewares/documentation.js +25 -0
- package/server/middlewares/index.js +7 -0
- package/server/middlewares/restrict-access.js +24 -0
- package/server/public/index.html +70 -0
- package/server/public/login.html +145 -0
- package/server/register.js +11 -0
- package/server/routes/index.js +84 -0
- package/server/services/documentation.js +210 -0
- package/server/services/helpers/build-api-endpoint-path.js +185 -0
- package/server/services/helpers/build-component-schema.js +216 -0
- package/server/services/helpers/index.js +9 -0
- package/server/services/helpers/utils/clean-schema-attributes.js +235 -0
- package/server/services/helpers/utils/get-api-responses.js +105 -0
- package/server/services/helpers/utils/get-schema-data.js +32 -0
- package/server/services/helpers/utils/loop-content-type-names.js +53 -0
- package/server/services/helpers/utils/pascal-case.js +9 -0
- package/server/services/helpers/utils/query-params.js +95 -0
- package/server/services/helpers/utils/routes.js +10 -0
- package/server/services/index.js +7 -0
- package/strapi-admin.js +3 -0
- package/strapi-server.js +3 -0
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
module.exports = [
|
|
4
|
+
{
|
|
5
|
+
name: 'sort',
|
|
6
|
+
in: 'query',
|
|
7
|
+
description: 'Sort by attributes ascending (asc) or descending (desc)',
|
|
8
|
+
deprecated: false,
|
|
9
|
+
required: false,
|
|
10
|
+
schema: {
|
|
11
|
+
type: 'string',
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
name: 'pagination[withCount]',
|
|
16
|
+
in: 'query',
|
|
17
|
+
description: 'Retun page/pageSize (default: true)',
|
|
18
|
+
deprecated: false,
|
|
19
|
+
required: false,
|
|
20
|
+
schema: {
|
|
21
|
+
type: 'boolean',
|
|
22
|
+
},
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
name: 'pagination[page]',
|
|
26
|
+
in: 'query',
|
|
27
|
+
description: 'Page number (default: 0)',
|
|
28
|
+
deprecated: false,
|
|
29
|
+
required: false,
|
|
30
|
+
schema: {
|
|
31
|
+
type: 'integer',
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: 'pagination[pageSize]',
|
|
36
|
+
in: 'query',
|
|
37
|
+
description: 'Page size (default: 25)',
|
|
38
|
+
deprecated: false,
|
|
39
|
+
required: false,
|
|
40
|
+
schema: {
|
|
41
|
+
type: 'integer',
|
|
42
|
+
},
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
name: 'pagination[start]',
|
|
46
|
+
in: 'query',
|
|
47
|
+
description: 'Offset value (default: 0)',
|
|
48
|
+
deprecated: false,
|
|
49
|
+
required: false,
|
|
50
|
+
schema: {
|
|
51
|
+
type: 'integer',
|
|
52
|
+
},
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
name: 'pagination[limit]',
|
|
56
|
+
in: 'query',
|
|
57
|
+
description: 'Number of entities to return (default: 25)',
|
|
58
|
+
deprecated: false,
|
|
59
|
+
required: false,
|
|
60
|
+
schema: {
|
|
61
|
+
type: 'integer',
|
|
62
|
+
},
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
name: 'fields',
|
|
66
|
+
in: 'query',
|
|
67
|
+
description: 'Fields to return (ex: title,author)',
|
|
68
|
+
deprecated: false,
|
|
69
|
+
required: false,
|
|
70
|
+
schema: {
|
|
71
|
+
type: 'string',
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
name: 'populate',
|
|
76
|
+
in: 'query',
|
|
77
|
+
description: 'Relations to return',
|
|
78
|
+
deprecated: false,
|
|
79
|
+
required: false,
|
|
80
|
+
schema: {
|
|
81
|
+
type: 'string',
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
name: 'filters',
|
|
86
|
+
in: 'query',
|
|
87
|
+
description: 'Filters to apply',
|
|
88
|
+
deprecated: false,
|
|
89
|
+
required: false,
|
|
90
|
+
schema: {
|
|
91
|
+
type: 'object',
|
|
92
|
+
},
|
|
93
|
+
style: 'deepObject',
|
|
94
|
+
},
|
|
95
|
+
];
|
package/strapi-admin.js
ADDED
package/strapi-server.js
ADDED