Request

GitHub

Defines query and body for a request.

Returns Contract::Object via query and body.

Instance Methods

#body

#body(&block)

GitHub

Defines the request body for this request.

Body is parsed from the JSON request body.

Returns

Contract::Object

Yields Contract::Object

Example: instance_eval style

body do
  string :title
  decimal :amount
end

Example: yield style

body do |body|
  body.string :title
  body.decimal :amount
end

---

#description

#description(value = nil)

GitHub

The description for this request.

Metadata included in exports.

Parameters

Name	Type	Default	Description
value	String, nil	nil	The description.

Returns

String, nil

Example

action :create do
  request do
    description 'The invoice to create'
  end
end

---

#query

#query(&block)

GitHub

Defines query parameters for this request.

Query parameters are parsed from the URL query string.

Returns

Contract::Object

Yields Contract::Object

Example: instance_eval style

query do
  integer? :page
  string? :status, enum: :status
end

Example: yield style

query do |query|
  query.integer? :page
  query.string? :status, enum: :status
end

---