mtkachenk0 / paradocs Goto Github PK

For API that have logic changes inside but the structures cannot be modified (backward compatibility) would be usefull to implement method as for field

schema do 
  field(:from_id).present.as(:from_identifier)
end 

the result should not contain from_id but contain from_identifier with the very value of from_id

# Input:
{from_id: 1}
# Output:
{from_identifier: 1}

#7, #12, #26 features should be documented

It can be used for faster enrollment. a method which takes an object and outputs somewhere (STDOUT) a Paradocs::Schema declaration syntax that matches the given schema

• save the nesting
• detect type of the field
• all the given fields are present (?)

Extract schema metadata into a swagger compatible format

Example:

schema do 
  field(:name).type(:string).description("John")
  field(:age).type(:number).description("This field represents your age")
end

Idle policy is a policy that doesn't raise any error and passes validation anyways, but executes a block if the validation logic actually failed.

Any policy should be able to be run as idle_policy

It can be used for payload generation.

schema do 
  field(:name).type(:string).example("John")
  field(:age).type(:number).example(23)
  field(:gender).type(:string).options(:m, :f) # example can be random from the options unless defined
  field(:subscribe).type(:boolean).default(:true) # example can be default unless defined
end