class RspecApiDocs::Renderer::JSONRenderer::ExampleSerializer
Attributes
example[R]
Public Class Methods
new(example)
click to toggle source
# File lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb, line 7 def initialize(example) @example = example end
Public Instance Methods
to_h()
click to toggle source
# File lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb, line 11 def to_h { description: example.description, name: example.name, http_method: example.http_method, parameters: parameters, path: example.path, requests: example.requests, response_fields: response_fields, notes: example.notes, } end
Private Instance Methods
parameters()
click to toggle source
# File lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb, line 26 def parameters example.parameters.map do |parameter| { name: Name.(name: parameter.name, scope: parameter.scope), description: parameter.description, required: parameter.required, } end end
response_fields()
click to toggle source
# File lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb, line 36 def response_fields example.response_fields.map do |field| { name: Name.(name: field.name, scope: field.scope), description: field.description, type: field.type, } end end