openapi-jsonrpc-jsdoc 1.2.0 → 1.2.2

package/README.md

@@ -13,6 +13,7 @@ npm i openapi-jsonrpc-jsdoc --save-dev
 ```js
 // api/api-v1.js
 /**
+ * @json-rpc
  * @description Название API
  * @param {object} parameters - params
  * @param {string} parameters.id - id

package/index.js

@@ -13,7 +13,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
     dictionaries: ['jsdoc'],
     hierarchy: true,
   });
-  const tags = [];
+  const tags = new Set();
   const temporaryDocument = {
     'x-send-defaults': true,
     'openapi': '3.0.0',
@@ -59,17 +59,25 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
         BasicAuth: [],
       },
     ],
-    'tags': tags,
+    'tags': [],
   };
-  const requiredSchema = ['method', 'id', 'jsonrpc'];
-  for (const module of documents) {
-    const apiName = module.meta.filename.replace(/.js$/, '');
+  const requiredSchema = ['method', 'jsonrpc'];
+  prepare: for (const module of documents) {
+    let isJsonRpc = false;
 
     if (module.tags && Array.isArray(module.tags)) {
-      for (const tag of module.tags) {
-        tags.push(...new Set(tag.value.split(',').map(t => t.trim())));
+      for (const {title, value} of module.tags) {
+        if (title === 'json-rpc') {
+          isJsonRpc = true;
+        } else if (title === 'tags' && value) {
+          value.split(',').map(t => t.trim()).forEach(t => tags.add(t));
+        }
       }
     }
+    if (!isJsonRpc) {
+      continue prepare;
+    }
+    const apiName = module.meta.filename.replace(/.js$/, '');
 
     const schema = {
       post: {
@@ -77,7 +85,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
         deprecated: module.deprecated || false,
         summary: `/${apiName}`,
         description: module.description,
-        tags: tags,
+        tags: Array.from(tags),
         parameters: [],
         responses: {
           '200': {
@@ -113,7 +121,6 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
                     default: apiName,
                     description: `API method ${apiName}`,
                   },
-                  // todo делать разграничение для notification request (без id)
                   id: {
                     type: 'integer',
                     default: 1,
@@ -147,7 +154,23 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           if (parameter.type.names[0] === 'object') {
             return accumulator;
           }
-          const [type] = parameter.type.names;
+          let [type] = parameter.type.names;
+          let items;
+          switch (type) {
+            case 'Array.<string>': {
+              type = 'array';
+              items = { type: 'number' };
+              break;
+            }
+            case 'Array.<number>': {
+              type = 'array';
+              items = { type: 'string' };
+              break;
+            }
+            default: {
+              break;
+            }
+          }
           const description = parameter.description;
           let name;
           try {
@@ -163,6 +186,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
             [name]: {
               type,
               description,
+              items,
             },
           };
           return accumulator;
@@ -171,12 +195,11 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           title: 'Parameters',
           type: 'object',
           'default': exampleJSON,
-          required: requiredSchema,
+          required: [],
           properties: {},
         },
       );
       const schemaPostJsdoc = schema.post.requestBody.content['application/json'].schema;
-      schemaPostJsdoc.required.push('params');
       schemaPostJsdoc.properties.params = propertiesParameters;
     }
     temporaryDocument.paths[`${api}${apiName}`] = schema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-jsonrpc-jsdoc",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Transform JSDoc-annotated JSON-RPC 2.0 methods into OpenAPI 3.0 specifications. Auto-generates REST API documentation with complete schemas, parameters, and endpoint definitions.",
   "main": "index.js",
   "scripts": {