class SwaggerDocsGenerator::Actions::Response
# Test :response
Complete description field for action
Public Class Methods
new(&block)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 14 def initialize(&block) instance_eval(&block) if block_given? end
Public Instance Methods
to_hash()
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 18 def to_hash { @status.to_s => construct } end
Private Instance Methods
construct()
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 24 def construct element = {} element.merge!(description: @description || default_description) element.merge!(schema: @schema) if @schema.present? element.merge!(header: @header) if @header.present? element.merge!(example: @example) if @example.present? element end
default_description()
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 41 def default_description Rack::Utils::HTTP_STATUS_CODES[@status] end
description(text)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 37 def description(text) @description = text end
example(text)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 49 def example(text) @example = text end
header(text)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 45 def header(text) @header = text end
schema(&block)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 53 def schema(&block) @schema = SwaggerDocsGenerator::Actions::Schema.new(&block).to_hash end
status(text)
click to toggle source
# File lib/swagger_docs_generator/parser/actions/response.rb, line 33 def status(text) @status = text end