Module: OasRails::Builders::EsquemaBuilder

Defined in:
lib/oas_rails/builders/esquema_builder.rb

Class Method Summary collapse

Class Method Details

.build_incoming_schema(klass:, model_to_schema_class: EasyTalk) ⇒ Hash

Builds a schema for a class when it is used as incoming API data.

Parameters:

  • klass (Class) —

    The class for which the schema is built.

Returns:

  • (Hash) —

    The schema as a JSON-compatible hash.



9
10
11
12
13
14
15
16
 
# File 'lib/oas_rails/builders/esquema_builder.rb', line 9

def build_incoming_schema(klass:, model_to_schema_class: EasyTalk)
  build_schema(
    klass: klass,
    model_to_schema_class: model_to_schema_class,
    excluded_columns: OasRails.config.excluded_columns_incoming,
    exclude_primary_key: true
  )
end

.build_outgoing_schema(klass:, model_to_schema_class: EasyTalk) ⇒ Hash

Builds a schema for a class when it is used as outgoing API data.

Parameters:

  • klass (Class) —

    The class for which the schema is built.

Returns:

  • (Hash) —

    The schema as a JSON-compatible hash.



22
23
24
25
26
27
28
29
 
# File 'lib/oas_rails/builders/esquema_builder.rb', line 22

def build_outgoing_schema(klass:, model_to_schema_class: EasyTalk)
  build_schema(
    klass: klass,
    model_to_schema_class: model_to_schema_class,
    excluded_columns: OasRails.config.excluded_columns_outgoing,
    exclude_primary_key: false
  )
end