@team-supercharge/oasg 4.5.0 → 4.6.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.6.0](https://gitlab.com/team-supercharge/oasg/compare/v4.5.1...v4.6.0) (2022-09-20)
+
+
+### Features
+
+* add schema-enumeration custom linter function ([bd5cd09](https://gitlab.com/team-supercharge/oasg/commit/bd5cd090b7e3c5c85d19c13ee8f4d9f56ba6290c))
+
+### [4.5.1](https://gitlab.com/team-supercharge/oasg/compare/v4.5.0...v4.5.1) (2022-09-14)
+
+
+### Bug Fixes
+
+* **feign:** fix Date type to LocalDate type import ([3d9e7d7](https://gitlab.com/team-supercharge/oasg/commit/3d9e7d71e2df13275c3544afce9e9c384e5ecb29))
+
 ## [4.5.0](https://gitlab.com/team-supercharge/oasg/compare/v4.4.0...v4.5.0) (2022-06-13)
 
 

package/README.md

@@ -15,6 +15,7 @@ Design APIs in OpenAPI 3.0 format, lint them, and generate client/server package
 	* [Publish](#publish)
 * [Linter rules](#linter-rules)
   * [Custom rules](#custom-rules)
+  * [Custom functions](#custom-functions)
 * [Configuration](#configuration)
   * [Source](#source)
     * [Simple](#simple)
@@ -209,6 +210,34 @@ The following rules are defined in the custom _OASg Ruleset_.
 | property casing | `oasg-property-casing-camel`  | Y | enforces `camelCasing` for property names |
 | property casing | `oasg-property-casing-pascal` |   | enforces `PascalCasing` for property names |
 
+### Custom functions
+
+#### `schema-enumeration`
+
+The function enables to verify a value against a set of enumeration values defined in a schema.
+
+Function parameters:
+* `schema` - Name of the schema to be validated against, must contain `enum` definition
+* `file` - (optional) YAML file with `components.schemas` defined, otherwise the currently linted documenet is used
+
+Example usage in a custom project ruleset:
+
+```yaml
+project-valid-permissions:
+  recommended: true
+  type: style
+  severity: error
+  description: Property x-permissions should use values from the Permission enum
+  message: '{{error}}'
+  given:
+    - $.paths.*.*.x-permissions[*]
+  then:
+    function: schema-enumeration
+    functionOptions:
+      file: ./api/common.yaml
+      schema: Permission
+```
+
 ---
 
 ## Configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/rules/default.yaml

@@ -3,6 +3,7 @@ extends: spectral:oas
 functionsDir: './functions'
 functions:
   - path-casing
+  - schema-enumeration
 
 .common:
   object-names: &object-names

package/rules/functions/schema-enumeration.js

@@ -0,0 +1,39 @@
+const yaml = require('js-yaml');
+const fs   = require('fs');
+
+const CACHE_KEY = 'values';
+
+module.exports = function (targetVal, opts, _paths, otherValues) {
+  if (!this.cache.has(CACHE_KEY)) {
+    if (opts.file) {
+      // load document from file if needed
+      try {
+        document = yaml.load(fs.readFileSync(opts.file, 'utf8'));
+      }
+      catch (e) {
+        throw Error(`file ${opts.file} not found`);
+      }
+    } else {
+      // otherwise get the current resolved document
+      document = otherValues.documentInventory.resolved;
+    }
+
+    if (!(document && document.components && document.components.schemas && document.components.schemas[opts.schema])) {
+      throw Error(`schema ${opts.schema} not found`);
+    }
+
+    if (!document.components.schemas[opts.schema].enum) {
+      throw Error(`schema ${opts.schema} must be an enumeration`);
+    }
+
+    this.cache.set(CACHE_KEY, document.components.schemas[opts.schema].enum);
+  }
+
+  const values = this.cache.get(CACHE_KEY);
+
+  if (!values.includes(targetVal)) {
+    return [ { message: `\`${targetVal}\` should be a valid entry from the ${opts.schema} enum` } ];
+  }
+
+  return;
+};

package/targets/feign/generator-config.json

@@ -7,9 +7,11 @@
   "generateForOpenFeign": true,
   "removeEnumValuePrefix": false,
   "typeMappings": {
-    "OffsetDateTime": "Instant"
+    "OffsetDateTime": "java.time.Instant",
+    "Date": "java.time.LocalDate"
   },
   "importMappings": {
-    "java.time.OffsetDateTime": "java.time.Instant"
+    "java.time.OffsetDateTime": "java.time.Instant",
+    "java.util.Date": "java.time.LocalDate"
   }
 }