@strapi/plugin-documentation 4.3.0-beta.2 → 4.3.2-alpha.0

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.
Files changed (2) hide show
  1. package/README.md +3 -3
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -16,7 +16,7 @@ This plugin automates your API documentation creation. It basically generates a
16
16
 
17
17
  ### Config
18
18
 
19
- The plugin comes with a `settings.json` file located in `./my-project/plugins/documentation/config` folder where you can specify all your environment variables, licenses, external documentation and so one...
19
+ Create a `settings.json` file located in `src/extensions/documentation/config` folder where you can specify all your environment variables, licenses, external documentation and so one...
20
20
  You can add all the entries listed in the [specification](https://swagger.io/specification/).
21
21
 
22
22
  _NOTE_ if you need to add a custom key you can do it by prefixing your key by `x-{something}`
@@ -47,7 +47,7 @@ When you start your server with this plugin installed it will automatically crea
47
47
 
48
48
  #### full_documentation.json
49
49
 
50
- The combined documentation is merged into the `full_documentation.json` file and it's located in `./plugins/documentation/{version}/full_documentation.json`
50
+ The combined documentation is merged into the `full_documentation.json` file and it's located in `src/extensions/documentation/documentation/{version}/full_documentation.json`
51
51
 
52
52
  It has the following structure
53
53
 
@@ -83,7 +83,7 @@ Overriding the `full_documentation.json` is a bad idea since it will be regenera
83
83
 
84
84
  **_NOTE 2_**
85
85
 
86
- You can easily modify the description, summary, parameters of a path however, for a response like the `200` you will need to write the full object. Take a look at the `./plugins/users-permissions/documentation/overrides/1.0.0/users-permissions-User.json` for a complete example.
86
+ You can modify the `tags`, `paths`, and `components` keys on the generated documentation by providing replacement values. You can see how the API is used in the users-permissions plugin: `packages/plugins/users-permissions/server/register.js`
87
87
 
88
88
  ### FAQ
89
89
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@strapi/plugin-documentation",
3
- "version": "4.3.0-beta.2",
3
+ "version": "4.3.2-alpha.0",
4
4
  "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -24,10 +24,10 @@
24
24
  "test": "echo \"no tests yet\""
25
25
  },
26
26
  "dependencies": {
27
- "@strapi/helper-plugin": "4.3.0-beta.2",
28
- "@strapi/utils": "4.3.0-beta.2",
27
+ "@strapi/helper-plugin": "4.3.2-alpha.0",
28
+ "@strapi/utils": "4.3.2-alpha.0",
29
29
  "bcryptjs": "2.4.3",
30
- "cheerio": "^1.0.0-rc.5",
30
+ "cheerio": "^1.0.0-rc.12",
31
31
  "fs-extra": "10.0.0",
32
32
  "koa-static": "^5.0.0",
33
33
  "lodash": "4.17.21",
@@ -42,7 +42,7 @@
42
42
  "react-router-dom": "5.2.0",
43
43
  "redux": "^4.0.1",
44
44
  "reselect": "^4.0.0",
45
- "swagger-ui-dist": "4.11.1",
45
+ "swagger-ui-dist": "4.12.0",
46
46
  "yaml": "1.10.2"
47
47
  },
48
48
  "peerDependencies": {
@@ -58,5 +58,5 @@
58
58
  "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
59
59
  "kind": "plugin"
60
60
  },
61
- "gitHead": "42aba356ad1b0751584d3b375e83baa4a2c18f65"
61
+ "gitHead": "8ab2db1497c3a5a805173b2d92248648b40a6f65"
62
62
  }