class BookXMLSchema
- BookXMLSchema
- Amber::Schema::Definition
- Reference
- Object
Overview
Define a schema for parsing XML book data
Defined in:
amber/schema/examples/xml_parser_example.crClass Method Summary
-
.additional_properties?
Define a schema for parsing XML book data
-
.conditional_groups
Define a schema for parsing XML book data
-
.content_types
Define a schema for parsing XML book data
-
.failure_type
Define a schema for parsing XML book data
-
.fields
Define a schema for parsing XML book data
-
.nested_array_schemas
Define a schema for parsing XML book data
-
.nested_schemas
Define a schema for parsing XML book data
-
.required_fields
Define a schema for parsing XML book data
-
.requires_one_of_groups
Define a schema for parsing XML book data
-
.requires_together_groups
Define a schema for parsing XML book data
-
.source_blocks
Define a schema for parsing XML book data
-
.success_type
Define a schema for parsing XML book data
-
.validators
Define a schema for parsing XML book data
Instance Method Summary
-
#author : String | Nil
Store options in field definition Create getter for the field
-
#book_id : String | Nil
Create getter for the field
-
#genre : String | Nil
Create getter for the field
-
#isbn : String | Nil
Store options in field definition Create getter for the field
-
#isbn13 : String | Nil
Create getter for the field
-
#price : Float32 | Nil
Store options in field definition Create getter for the field
-
#publisher : String | Nil
Create getter for the field
-
#title : String | Nil
Store options in field definition Create getter for the field
-
#year : Int32 | Nil
Store options in field definition Create getter for the field
Instance methods inherited from class Amber::Schema::Definition
errors : Array(Amber::Schema::Error)
errors,
parse : LegacyResult
parse,
raw_data : Hash(String, JSON::Any)
raw_data,
to_h : Hash(String, JSON::Any)
to_h,
validate : LegacyResult
validate,
validate_typed : Success(Hash(String, JSON::Any)) | Failure(Hash(String, JSON::Any))
validate_typed,
validated_data : Hash(String, JSON::Any) | Nil
validated_data
Constructor methods inherited from class Amber::Schema::Definition
new(raw_data : Hash(String, JSON::Any))
new
Class methods inherited from class Amber::Schema::Definition
additional_properties? : Bool
additional_properties?,
conditional_groups : Array(ConditionalGroup)
conditional_groups,
conditionals : Array(ConditionalGroup)
conditionals,
content_types : Array(String)
content_types,
field_names : Array(String)
field_names,
fields : Hash(String, FieldDef)
fields,
has_conditionals? : Bool
has_conditionals?,
has_field?(name : String) : Bool
has_field?,
nested_array_schemas : Hash(String, Definition.class)
nested_array_schemas,
nested_schemas : Hash(String, Definition.class)
nested_schemas,
required_field_names : Array(String)
required_field_names,
required_fields : Array(String)
required_fields,
requires_one_of_groups : Array(Array(String))
requires_one_of_groups,
requires_together_groups : Array(Array(String))
requires_together_groups,
source_blocks : Array(SourceBlock)
source_blocks,
uses_body_params? : Bool
uses_body_params?,
uses_header_params? : Bool
uses_header_params?,
uses_path_params? : Bool
uses_path_params?,
uses_query_params? : Bool
uses_query_params?,
validators : Array(Validator::Base)
validators
Macros inherited from class Amber::Schema::Definition
additional_properties(allowed)
additional_properties,
content_type(*types)
content_type,
field(name, type, **options)
field,
from_body
from_body,
from_header
from_header,
from_path
from_path,
from_query
from_query,
nested(name, schema_class, **options)
nested,
requires_one_of(*fields)
requires_one_of,
requires_together(*fields)
requires_together,
validate(method_name = nil, &block)
validate,
validates_to(success_type, failure_type = ValidationError)
validates_to,
when_field(field, value, &block)
when_field,
when_present(field, &block)
when_present
Class Method Detail
Instance Method Detail
Store options in field definition Create getter for the field
Store options in field definition Create getter for the field
Store options in field definition Create getter for the field