Schema isn't being recognised

I’m trying to create a plugin and so far it’s working great apart from the schema part.

I have the following manifest.js file:

module.exports = {
  version: '1.0.0',
  init: function (pluginContext) {
    pluginContext.registerPolicy(require('./policies/blacklist.js'))
  }
}

And the following policies/blacklist.js file:

module.exports = {
  name: 'blacklist',

  schema: {
    $id: 'http://express-gateway.io/schemas/policy/blacklist.json',
    type: 'object',
    required: ['urls'],
    properties: {
      urls: {
        type: 'array',
        items: {
          properties: {
            method: {
              type: 'string'
            },
            path: {
              type: ['string', 'null']
            }
          }
        }
      }
    }
  },

  policy: (actionParams) => {
...

The policy works as expected but it’s not validating the schema.

I get the following output from my console:

[EG:config] info: Registered schema for users model.
[EG:config] info: Registered schema for credentials model.
[EG:config] info: Registered schema for applications model.
[EG:config] debug: ConfigPath:
[EG:config] debug: ConfigPath:
[EG:plugins] debug: Loading plugins. Plugin engine version:
[EG:plugins] debug: Loading plugin
[EG:gateway] warn: express-gateway-plugin-bts-blacklist plugin hasn't provided a schema. Validation for this plugin will be skipped.
[EG:plugins] info: Loaded plugin
[EG:gateway] debug: registering policy

Note the specific part:

[EG:gateway] warn: express-gateway-plugin-bts-blacklist plugin hasn't provided a schema. Validation for this plugin will be skipped.

I am confused as I have specified the schema. It’s just ignoring it.

I’m using Express Gateway 1.10.1.

[XVincentX]

Hey @markwylde

this is not an Express Gateway issue. By default, the JSON Schema are permissive — which means that foreign properties are allowed.

You can fix this in two ways:

• Make the method element required, so if you spell it incorrectly, you get an error:

{
    $id: 'http://express-gateway.io/schemas/policy/blacklist.json',
    type: 'object',
    required: ['urls'],
    properties: {
      urls: {
        type: 'array',
        items: {
          required: ['method'],
          properties: {
            method: {
              type: 'string'
            },
            path: {
              type: ['string', 'null']
            }
          }
        }
      }
    }
  }

• Set the additionalProperties to false, so that provided objects MUST have only the declared properties:

{
    $id: 'http://express-gateway.io/schemas/policy/blacklist.json',
    type: 'object',
    required: ['urls'],
    properties: {
      urls: {
        type: 'array',
        items: {
          additionalProperties: false,
          properties: {
            method: {
              type: 'string'
            },
            path: {
              type: ['string', 'null']
            }
          }
        }
      }
    }
  }

Note: the second one, if I recall correctlu is an ajv specific feature.

[XVincentX]

This is fine, it happens to everybody. In case you need any further help you can jump in our Gitter Channel too.