Removed notion of "version" in admin-api-schema's API

refs https://github.com/TryGhost/Toolbox/issues/314

- The Ghost API has gotten rid of the "version", so there's no need to keep this concept in the JSON Schema's either as it would always be called with a single "latest" or "current" state

Author: naz

packages/admin-api-schema/README.md

@@ -65,8 +65,7 @@ When used from Ghost core in validation layer:
 const jsonSchema = require('@tryghost/admin-api-schema');
 const validate = async (apiConfig, frame) => await jsonSchema.validate({
     data: frame.data,
-    schema: `${apiConfig.docName}-${apiConfig.method}`,
-    version: 'canary'
+    schema: `${apiConfig.docName}-${apiConfig.method}`
 });
 ```
 

packages/admin-api-schema/lib/admin-api-schema.js

@@ -3,13 +3,12 @@ const jsonSchema = require('./utils/json-schema');
 
 /**
  *
- * @param {'v2'|'v3'|'canary'} version - API's JSON schema version to check against
- * @param {string} name -JSON schema to retreive from "version" folder
+ * @param {string} name -JSON schema to retreive from "schemas" folder
  *
  * @returns {Object} - JSON schema file content
  */
-const getJSONDefinition = (version, name) => {
-    const definitionPath = `./${version}/${name}`;
+const getJSONDefinition = (name) => {
+    const definitionPath = `./schemas/${name}`;
 
     try {
         return require(definitionPath);
@@ -21,45 +20,19 @@ const getJSONDefinition = (version, name) => {
 };
 
 /**
- * Resolves with a schema definition content. At the moment it contains unresolved `$ref` statements.
- * This method needs some additional work to be useful for outside consumer - contain resolved '$ref'.
- *
- * @param {Object} options
- * @param {'v2'|'v3'|'canary'} - API's JSON schema version to check against
- * @param {string} options.schema - name of JSON schema definition, comes from available optios returned by list()
- */
-const get = ({version, schema}) => {
-    if (!list({version}).includes(schema)) {
-        return null;
-    }
-
-    return getJSONDefinition(version, schema);
-};
-
-/**
- * Lists available JSON schema definitions for provided version
- *
- * @param {Object} options
- * @param {'v2'|'v3'|'v4'|'canary'} - API's JSON schema version to check against
+ * Lists available JSON schema definitions
  *
  * @returns {string[]} - list of available JSON schema definitions
  */
-const list = ({version}) => {
-    if (version === 'v2') {
-        return require('./v2');
-    } else if (version === 'v3') {
-        return require('./v3');
-    } else if (version === 'v4' || version === 'canary') {
-        return require('./canary');
-    }
+const list = () => {
+    return require('./schemas');
 };
 
 /**
  * Validate method parameters
  *
  * @typedef {Object} ValidateOptions
  * @property {Object} options.data - data to validate
- * @property {'v2'|'v3'|'canary'} options.version - API version to data belongs to, e.g.: 'v2', 'canary'
  * @property {string} [options.schema] - name of the schema to validate against. Available schema names are returned by list() function
  * @property {string} [options.definition] - name of the definition where schema belongs
  */
@@ -71,8 +44,8 @@ const list = ({version}) => {
  *
  * @returns {Promise} - resolves a promise if validation is successful and rejects with error details otherwise
  */
-const validate = ({data, version, schema = '', definition = schema.split('-')[0]}) => {
-    const schemaJSON = get({schema, version});
+const validate = ({data, schema, definition = schema?.split('-')[0]}) => {
+    const schemaJSON = getJSONDefinition(schema);
 
     if (!schemaJSON) {
         throw new errors.IncorrectUsageError({
@@ -81,66 +54,13 @@ const validate = ({data, version, schema = '', definition = schema.split('-')[0]
         });
     }
 
-    const definitionJSON = getJSONDefinition(version, definition);
+    const definitionJSON = getJSONDefinition(definition);
 
     return jsonSchema.validate(schemaJSON, definitionJSON, data);
 };
 
-/**
- * Resolves version into "internal" one.
- * 'canary' is used to identify latest available version. Currently it's 'v3' and once there's
- * next version introduced - 'v4' should be resolved to 'canary', and 'v3' should be returned as is.
- *
- * @param {'v2'|'v3'|'v4'|'canary'} - version to resolve into internaly available version
- *
- * @returns {'v2'|'v3'|'canary'} - resolved version
- */
-const resolveVersion = (version) => {
-    switch (version) {
-    case 'canary':
-    case 'v4':
-        return 'canary';
-    case 'v3':
-        return 'v3';
-    case 'v2':
-        return 'v2';
-    default:
-        throw new errors.IncorrectUsageError({
-            message: `Unrecognised version ${version}.`
-        });
-    }
-};
-
-/**
- * Versioned version of 'get' method, which returns a JSON schema definition if found
- *
- * @param {string} schema - name of JSON schema definitions
- * @param {string} version - API's JSON schema version to check against
- *
- * @returns {Object|null} JSON schema definition or null if it's not found
- */
-const versionedGet = (schema, version = 'v4') => get({schema, version: resolveVersion(version)});
-
-/**
- * Versioned version of 'list' method, which lisists available JSON schema definitions for provided version
- *
- * @param {string} version - API's JSON schema version to check against
- *
- * @returns {string[]} - list of available JSON schema definitions
- */
-const versionedList = (version = 'v4') => list({version: resolveVersion(version)});
-
-/**
- * Versioned version of 'validate' method, which validates objects against predefined JSON Schema
- *
- * @param {ValidateOptions} options
- *
- * @returns {Promise} - resolves a promise if validation is successful and rejects with error details otherwise
- */
-const versionedValidate = options => validate(Object.assign(options, {version: resolveVersion(options.version || 'v4')}));
-
 module.exports = {
-    get: versionedGet,
-    list: versionedList,
-    validate: versionedValidate
+    get: getJSONDefinition,
+    list: list,
+    validate: validate
 };