openapi-jsonrpc-jsdoc 1.0.3 → 1.0.4

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/openapi-jsonrpc-jsdoc.iml" filepath="$PROJECT_DIR$/.idea/openapi-jsonrpc-jsdoc.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/openapi-jsonrpc-jsdoc.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,12 +1,13 @@
 # openapi-jsonrpc-jsdoc
 
-Install
+## Install
 ```fish
 npm i openapi-jsonrpc-jsdoc --save-dev
 ```
 
 ## Example
-### Create JSON-RPC Methoc
+
+### Create JSON-RPC Method
 ```js
 // api/api-v1.js
 /**
@@ -39,7 +40,7 @@ openapiJSONRpcJSDoc({
 ```
 
 <details>
-<summary>Result</summary>
+<summary>See result</summary>
 
 ```json
 {
@@ -147,4 +148,4 @@ openapiJSONRpcJSDoc({
 }
 ```
 
-</details>
+</details>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-jsonrpc-jsdoc",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "OpenAPI generator",
   "main": "index.js",
   "scripts": {
@@ -11,25 +11,31 @@
     "url": "git+https://github.com/qertis/openapi-jsonrpc-jsdoc.git"
   },
   "keywords": [
-    "openapi",
-    "open api",
-    "postman",
-    "swagger",
-    "jsdoc",
-    "json-rpc",
-    "jsonrpc",
-    "generator"
+    "openapi jsdoc",
+    "open api js doc",
+    "postman jsdoc",
+    "swagger jsondoc",
+    "openapi jsondoc",
+    "json-rpc openapi",
+    "json-rpc swagger",
+    "jsonrpc openapi",
+    "generator documentation openapi jsonrpc 2.0"
   ],
-  "author": "qertis",
+  "author": "Denis Baskovsky <baskovsky@yandex.ru> (https://baskovsky.ru/)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/qertis/openapi-jsonrpc-jsdoc/issues"
   },
   "homepage": "https://github.com/qertis/openapi-jsonrpc-jsdoc#readme",
   "dependencies": {
-    "jsdoc-x": "~4.0.3"
+    "jsdoc-x": "~4.1.0"
   },
   "devDependencies": {
-    "ava": "~2.4.0"
+    "ava": "~3.15.0",
+    "express": "~4.18.2",
+    "express-openapi-validator": "~5.0.4"
+  },
+  "engines": {
+    "node": ">= 14"
   }
 }

package/.github/workflows/nodejs.yml

@@ -1,25 +0,0 @@
-name: Node CI
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x]
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: npm install and test
-      run: |
-        npm i
-        npm test
-      env:
-        CI: true

package/.github/workflows/npmpublish.yml

@@ -1,45 +0,0 @@
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-          registry-url: https://registry.npmjs.org/
-      - run: npm i
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12
-          registry-url: https://npm.pkg.github.com/
-          scope: '@qertis'
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/test/api/v1.js

@@ -1,8 +0,0 @@
-/**
- * @description Название API
- * @param {object} parameters - params
- * @param {string} parameters.id - id
- */
-module.exports = (parameters) => {
-  return parameters.id;
-};

package/test/api/v2.js

@@ -1,8 +0,0 @@
-/**
- * @deprecated
- * @description Название API 2
- * @return {null}
- */
-module.exports = () => {
-  return null;
-};

package/test/index.test.js

@@ -1,39 +0,0 @@
-const test = require('ava');
-const openapiJSONRpcJSDoc = require('../index');
-
-test.before(async t => {
-  t.context.data = await openapiJSONRpcJSDoc({
-    api: '/api/',
-    securitySchemes: {
-      BasicAuth: {
-        type: 'http',
-        scheme: 'digest',
-      },
-    },
-    servers: [
-      {
-        url: '0.0.0.0:8080',
-      },
-    ],
-    packageUrl: './package.json',
-    files: './test/api/*.js',
-  });
-});
-
-test('t1', t => {
-  const data = t.context.data;
-  const v1Test = data.paths['/api/v1'];
-  t.false(v1Test.post.deprecated);
-  t.is(typeof v1Test.post.description, 'string');
-  t.true(Array.isArray(v1Test.post.tags));
-  t.true(Array.isArray(v1Test.post.parameters));
-  const v1RequestBodySchema = v1Test.post.requestBody.content['application/json'].schema;
-  t.is(v1RequestBodySchema.type, 'object');
-  t.true(v1RequestBodySchema.required.includes('id'));
-});
-
-test('t2', t => {
-  const data = t.context.data;
-  const v2Test = data.paths['/api/v2'];
-  t.true(v2Test.post.deprecated);
-});