class Amazonite::ApiGateway::Model

Overview

Represents the data structure of a method's request or response payload.

Included Modules

Defined in:

api_gateway/model.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(id : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, schema : String | Nil = nil, content_type : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def content_type : String | Nil #

The content-type for the model.


[View source]
def content_type=(content_type : String | Nil) #

The content-type for the model.


[View source]
def description : String | Nil #

The description of the model.


[View source]
def description=(description : String | Nil) #

The description of the model.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def id : String | Nil #

The identifier for the model resource.


[View source]
def id=(id : String | Nil) #

The identifier for the model resource.


[View source]
def name : String | Nil #

The name of the model. Must be an alphanumeric string.


[View source]
def name=(name : String | Nil) #

The name of the model. Must be an alphanumeric string.


[View source]
def schema : String | Nil #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "*/" characters in the description of any properties because such "*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.


[View source]
def schema=(schema : String | Nil) #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "*/" characters in the description of any properties because such "*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.


[View source]
def validate! : Nil #

[View source]