annon_api

v0.16.2

annon_api v0.16.2 Annon.Plugins.Validator

JSON Schema Validation plugin allows you to set validation rules for a path relative to an API.

It’s response structure described in our API Manifest.

Link to this section Summary

Functions

execute(conn, map1, map2)

Executes Plugin

prepare(request)

Loads Plugin features from application configuration and modifies request features

settings_validation_schema()

Validates JSON Schema that can be used to validate Plugin settings

validate_settings(changeset)

Validates Plugin settings

Link to this section Functions

Link to this function execute(conn, map1, map2)

Executes Plugin.

Receives Annon.Plugin.Request structure, which allows Plugin to:

  • Set properties for upstream request (in conn.assigns.upstream_request).
  • Modify connection if this feature was enabled.

Callback implementation for Annon.Plugin.execute/3.

Link to this function prepare(request)

Loads Plugin features from application configuration and modifies request features.

Link to this function settings_validation_schema()

Validates JSON Schema that can be used to validate Plugin settings.

Callback implementation for Annon.Plugin.settings_validation_schema/0.

Link to this function validate_settings(changeset)

Validates Plugin settings.

Callback implementation for Annon.Plugin.validate_settings/1.