Module: Pigeon::Schema

Defined in:

lib/pigeon/schema.rb

Overview

Schema-related functionality for Pigeon

Class Method Summary

• .register_schema(name, schema) ⇒ void

  Register a JSON schema for validation.

• .register_sensitive_field(field) ⇒ void

  Register a sensitive field for masking.

• .register_sensitive_fields(fields) ⇒ void

  Register multiple sensitive fields for masking.

• .schema(name) ⇒ Hash, ...

  Get a registered schema.

Class Method Details

.register_schema(name, schema) ⇒ void

This method returns an undefined value.

Register a JSON schema for validation

Parameters:

• name (String, Symbol) —

  Schema name

• schema (Hash, String) —

  JSON schema

# File 'lib/pigeon/schema.rb', line 10

def self.register_schema(name, schema)
  Configuration.register_schema(name, schema)
end

.register_sensitive_field(field) ⇒ void

This method returns an undefined value.

Register a sensitive field for masking

Parameters:

• field (String, Symbol) —

  Field name

# File 'lib/pigeon/schema.rb', line 24

def self.register_sensitive_field(field)
  Configuration.register_sensitive_field(field)
end

.register_sensitive_fields(fields) ⇒ void

This method returns an undefined value.

Register multiple sensitive fields for masking

Parameters:

• fields (Array<String, Symbol>) —

  Field names

# File 'lib/pigeon/schema.rb', line 31

def self.register_sensitive_fields(fields)
  Configuration.register_sensitive_fields(fields)
end

.schema(name) ⇒ Hash, ...

Get a registered schema

Parameters:

• name (String, Symbol) —

  Schema name

Returns:

• (Hash, String, nil) —

  JSON schema or nil if not found

# File 'lib/pigeon/schema.rb', line 17

def self.schema(name)
  Configuration.schema(name)
end