@strapi/plugin-documentation 4.3.8 → 4.3.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.3.8",
+  "version": "4.3.9",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,8 +24,8 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.3.8",
-    "@strapi/utils": "4.3.8",
+    "@strapi/helper-plugin": "4.3.9",
+    "@strapi/utils": "4.3.9",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.12",
     "fs-extra": "10.0.0",
@@ -53,7 +53,7 @@
     "msw": "0.42.3"
   },
   "engines": {
-    "node": ">=14.19.1 <=16.x.x",
+    "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
   "strapi": {
@@ -62,5 +62,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "c44f21d5ba95d3f2fbba239cf241081dddd54dd7"
+  "gitHead": "8ebf58d9edb62872acf88d19d1f878b4a1632ff7"
 }

package/server/services/documentation.js

@@ -15,12 +15,13 @@ module.exports = ({ strapi }) => {
 
   return {
     registerDoc(doc) {
+      let registeredDoc = doc;
       // parseYaml
       if (typeof doc === 'string') {
-        doc = require('yaml').parse(doc);
+        registeredDoc = require('yaml').parse(registeredDoc);
       }
       // receive an object we can register it directly
-      registeredDocs.push(doc);
+      registeredDocs.push(registeredDoc);
     },
     getDocumentationVersion() {
       return _.get(config, 'info.version');

package/server/services/helpers/build-api-endpoint-path.js

@@ -46,7 +46,7 @@ const getPathParams = (routePath) => {
         description: '',
         deprecated: false,
         required: true,
-        schema: { type: 'string' },
+        schema: { type: 'number' },
       };
     });
 };

package/server/services/helpers/build-component-schema.js

@@ -102,7 +102,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}LocalizationResponse`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           ...cleanSchemaAttributes(attributes, { addComponentSchema }),
         },
       },
@@ -118,7 +118,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}ListResponseDataItem`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: {
             type: 'object',
             properties: cleanSchemaAttributes(attributes, {
@@ -133,7 +133,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
       [`${pascalCase(uniqueName)}ListResponseDataItemLocalized`]: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: {
             type: 'object',
             properties: cleanSchemaAttributes(attributes, { addComponentSchema }),
@@ -172,7 +172,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     [`${pascalCase(uniqueName)}ResponseDataObject`]: {
       type: 'object',
       properties: {
-        id: { type: 'string' },
+        id: { type: 'number' },
         attributes: {
           type: 'object',
           properties: cleanSchemaAttributes(attributes, {
@@ -187,7 +187,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     [`${pascalCase(uniqueName)}ResponseDataObjectLocalized`]: {
       type: 'object',
       properties: {
-        id: { type: 'string' },
+        id: { type: 'number' },
         attributes: {
           type: 'object',
           properties: cleanSchemaAttributes(attributes, { addComponentSchema }),

package/server/services/helpers/utils/clean-schema-attributes.js

@@ -97,7 +97,7 @@ const cleanSchemaAttributes = (
         const rawComponentSchema = {
           type: 'object',
           properties: {
-            ...(isRequest ? {} : { id: { type: 'string' } }),
+            ...(isRequest ? {} : { id: { type: 'number' } }),
             ...cleanSchemaAttributes(componentAttributes, {
               typeMap,
               isRequest,
@@ -128,7 +128,7 @@ const cleanSchemaAttributes = (
           const rawComponentSchema = {
             type: 'object',
             properties: {
-              ...(isRequest ? {} : { id: { type: 'string' } }),
+              ...(isRequest ? {} : { id: { type: 'number' } }),
               __component: { type: 'string' },
               ...cleanSchemaAttributes(componentAttributes, {
                 typeMap,

package/server/services/helpers/utils/get-schema-data.js

@@ -15,7 +15,7 @@ module.exports = (isListOfEntities, attributes) => {
       items: {
         type: 'object',
         properties: {
-          id: { type: 'string' },
+          id: { type: 'number' },
           attributes: { type: 'object', properties: attributes },
         },
       },
@@ -25,7 +25,7 @@ module.exports = (isListOfEntities, attributes) => {
   return {
     type: 'object',
     properties: {
-      id: { type: 'string' },
+      id: { type: 'number' },
       attributes: { type: 'object', properties: attributes },
     },
   };

package/server/services/helpers/utils/query-params.js

@@ -81,4 +81,15 @@ module.exports = [
       type: 'string',
     },
   },
+  {
+    name: 'filters',
+    in: 'query',
+    description: 'Filters to apply',
+    deprecated: false,
+    required: false,
+    schema: {
+      type: 'object',
+    },
+    style: 'deepObject',
+  },
 ];