class Praxis::Docs::OpenApi::OperationObject
Attributes
Public Class Methods
new(id:, url:, action:, tags:)
click to toggle source
# File lib/praxis/docs/open_api/operation_object.rb, line 14 def initialize(id:, url:, action:, tags:) @id = id @url = url @action = action @tags = tags end
Public Instance Methods
dump()
click to toggle source
# File lib/praxis/docs/open_api/operation_object.rb, line 21 def dump all_parameters = ParameterObject.process_parameters(action) all_tags = tags + action.traits h = { summary: action.name.to_s, # externalDocs: {}, # TODO/FIXME operationId: id, responses: ResponsesObject.new(responses: action.responses).dump # callbacks # deprecated: false # security: [{}] # servers: [{}] } # Handle versioning header/params for the action in a special way, by linking to the existing component # spec that will be generated globally api_info = ApiDefinition.instance.infos[action.endpoint_definition.version] if (version_with = api_info.version_with) all_parameters.push('$ref' => '#/components/parameters/ApiVersionHeader') if version_with.include?(:header) all_parameters.push('$ref' => '#/components/parameters/ApiVersionParam') if version_with.include?(:params) end h[:description] = action.description if action.description h[:tags] = all_tags.uniq unless all_tags.empty? h[:parameters] = all_parameters unless all_parameters.empty? h[:requestBody] = RequestBodyObject.new(attribute: action.payload).dump if action.payload h end