Action

GitHub

Wraps action definitions within a resource.

Example

resource.actions[:show].method # => :get
resource.actions[:show].path # => "/posts/:id"
resource.actions[:create].request # => Action::Request

resource.actions.each_value do |action|
  action.method # => :get, :post, :patch, :delete
  action.request # => Action::Request
  action.response # => Action::Response
  action.deprecated? # => false
end

Modules

• Request
• Response

Instance Methods

#deprecated?

#deprecated?

GitHub

Whether this action is deprecated.

Returns

Boolean

---

#description

#description

GitHub

The description for this action.

Returns

String, nil

---

#method

#method

GitHub

The method for this action.

Returns

Symbol

---

#operation_id

#operation_id

GitHub

The operation ID for this action.

Returns

String, nil

---

#path

#path

GitHub

The path for this action.

Returns

String

---

#raises

#raises

GitHub

The raises for this action.

Returns

Array<Symbol>

---

#request

#request

GitHub

The request for this action.

Returns

Action::Request

---

#response

#response

GitHub

The response for this action.

Returns

Action::Response

---

#summary

#summary

GitHub

The summary for this action.

Returns

String, nil

---

#tags

#tags

GitHub

The tags for this action.

Returns

Array<String>

---

#to_h

#to_h

GitHub

Converts this action to a hash.

Returns

Hash

---