jsdoc

lib/schema-manager.js

@@ -48,7 +48,7 @@ class SchemaManager {
    *
    * @param {Sequelize.Model} model Instance of Sequelize.Model
    * @param {StrategyInterface} strategy Strategy instance
-   * @returns {string} Json string containing the schema
+   * @returns {object} Object contaiing the strategy-specific schema
    */
   generate(model, strategy) {
     if (model === undefined) throw new Error('Missing method argument');

lib/strategies/json-schema-v7.js

@@ -3,7 +3,7 @@
 const StrategyInterface = require('../strategy-interface');
 
 /**
- * Strategy class responsible for converting Sequelize models into "JSON Schema v7" schemas.
+ * Class responsible for converting Sequelize models into "JSON Schema Draft-07" schemas.
  *
  * @augments StrategyInterface
  */
@@ -55,7 +55,7 @@ class JsonSchema7Strategy extends StrategyInterface {
   /**
    * Returns `null` to be used as direct property of `format`
    *
-   * @example
+   * @example null
    *
    * @returns {object|string}
    */

lib/strategies/openapi-v3.js

@@ -3,15 +3,15 @@
 const StrategyInterface = require('../strategy-interface');
 
 /**
- * Strategy class responsible for converting Sequelize models into "OpenAPI v3" schemas.
+ * Class responsible for converting Sequelize models into "OpenAPI 3.0" schemas.
  *
  * @augments StrategyInterface
  */
 class OpenApi3Strategy extends StrategyInterface {
   /**
    * Returns the full URI to the online OpenAPI v3 schema (validation) file.
    *
-   * @example https://github.com/OAI/OpenAPI-Specification/raw/master/schemas/v2.0/schema.json
+   * @example https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v3.0/schema.json
 
    * @returns {string}
    */
@@ -21,7 +21,7 @@ class OpenApi3Strategy extends StrategyInterface {
 
   /**
    * OpenAPI v3 does not support/allow support the "schema" property so we
-   * omit the property from appearing in the schema by returning `null`.
+   * omit the property from the schema by returning `null`.
    *
    * @example null
    *
@@ -33,7 +33,7 @@ class OpenApi3Strategy extends StrategyInterface {
 
   /**
    * OpenAPI v3 does not support/allow support the "identifier" property so we
-   * omit the property from appearing in the schema by returning `null`.
+   * omit the property from the schema by returning `null`.
    *
    * @example null
    *
@@ -57,7 +57,7 @@ class OpenApi3Strategy extends StrategyInterface {
   /**
    * Returns new property `nullable: true` used as new property
    *
-   * @example
+   * @example { 'nullable': 'true' }
    *
    * @returns {object|string}
    */

lib/strategy-interface.js

@@ -62,17 +62,6 @@ class StrategyInterface {
     this.constructor._throwMissingImplementationError(this.constructor.name, 'getNullProperty');
   }
 
-  /**
-   * Must return the strategy specific 'example' property.
-   *
-   * @param {string} raw Raw value as derived from the Sequelize model
-   * @returns {object|null}
-   */
-  // prettier-ignore
-  getExampleProperty(raw) { // eslint-disable-line no-unused-vars
-    this.constructor._throwMissingImplementationError(this.constructor.name, 'getExampleProperty');
-  }
-
   /**
    * Throws an error if the strategy has not impemented one of the required methods.
    *