@flink-app/api-docs-plugin 0.2.0-beta.1 → 0.2.0-beta.15

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.
@@ -14,3 +14,9 @@ html
14
14
  h3 Response schema
15
15
  pre
16
16
  code #{handler.schema.resSchema ? JSON.stringify(handler.schema.resSchema || {}, null, 2) : "n/a"}
17
+ h3 Query
18
+ pre
19
+ code #{handler.queryMetadata ? JSON.stringify(handler.queryMetadata || {}, null, 2) : "n/a"}
20
+ h3 Params
21
+ pre
22
+ code #{handler.paramsMetadata ? JSON.stringify(handler.paramsMetadata || {}, null, 2) : "n/a"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flink-app/api-docs-plugin",
3
- "version": "0.2.0-beta.1",
3
+ "version": "0.2.0-beta.15",
4
4
  "description": "Flink plugin that generates API documentation based on JSON schemas",
5
5
  "scripts": {
6
6
  "test": "echo \"Error: no test specified\"",
@@ -16,7 +16,7 @@
16
16
  "pug": "^3.0.2"
17
17
  },
18
18
  "devDependencies": {
19
- "@flink-app/flink": "^0.2.0-beta.1",
19
+ "@flink-app/flink": "^0.2.0-beta.15",
20
20
  "@types/express": "^4.17.12",
21
21
  "@types/got": "^9.6.11",
22
22
  "@types/node": "^15.6.2",
@@ -26,5 +26,5 @@
26
26
  "tsc-watch": "^4.2.9",
27
27
  "typescript": "^4.2.4"
28
28
  },
29
- "gitHead": "c38d7be844f24062fc9f8f6468664182250b3173"
29
+ "gitHead": "798ef9a11c291c0b16ed937436dd46986942546c"
30
30
  }
@@ -14,3 +14,9 @@ html
14
14
  h3 Response schema
15
15
  pre
16
16
  code #{handler.schema.resSchema ? JSON.stringify(handler.schema.resSchema || {}, null, 2) : "n/a"}
17
+ h3 Query
18
+ pre
19
+ code #{handler.queryMetadata ? JSON.stringify(handler.queryMetadata || {}, null, 2) : "n/a"}
20
+ h3 Params
21
+ pre
22
+ code #{handler.paramsMetadata ? JSON.stringify(handler.paramsMetadata || {}, null, 2) : "n/a"}
@@ -1,3 +0,0 @@
1
- import { Request, Response } from "express";
2
- declare const getApiDocs: (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
3
- export default getApiDocs;
@@ -1,44 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __generator = (this && this.__generator) || function (thisArg, body) {
12
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
13
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
- function verb(n) { return function (v) { return step([n, v]); }; }
15
- function step(op) {
16
- if (f) throw new TypeError("Generator is already executing.");
17
- while (_) try {
18
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
19
- if (y = 0, t) op = [op[0] & 2, t.value];
20
- switch (op[0]) {
21
- case 0: case 1: t = op; break;
22
- case 4: _.label++; return { value: op[1], done: false };
23
- case 5: _.label++; y = op[1]; op = [0]; continue;
24
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
- default:
26
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
- if (t[2]) _.ops.pop();
31
- _.trys.pop(); continue;
32
- }
33
- op = body.call(thisArg, _);
34
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
- }
37
- };
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- var getApiDocs = function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
40
- return __generator(this, function (_a) {
41
- return [2 /*return*/, res.send(200)];
42
- });
43
- }); };
44
- exports.default = getApiDocs;