openapi3_parser.rb

# frozen_string_literal: true

files = Dir.glob(File.join(__dir__, "openapi3_parser", "**", "*.rb"))
files.each { |file| require file }

module Openapi3Parser
  # For a variety of inputs this will construct an OpenAPI document. For a
  # String/File input it will try to determine if the input is JSON or YAML.
  #
  # @param  [String, Hash, File]  input           Source for the OpenAPI document
  # @param [Boolean]              emit_warnings   Whether to call Kernel.warn when
  #                                               warnings are output, best set to
  #                                               false when parsing specification
  #                                               files you've not authored
  #
  # @return [Document]
  def self.load(input, emit_warnings: true)
    Document.new(SourceInput::Raw.new(input), emit_warnings:)
  end

  # For a given string filename this will read the file and parse it as an
  # OpenAPI document. It will try detect automatically whether the contents
  # are JSON or YAML.
  #
  # @param  [String]  path            Filename of the OpenAPI document
  # @param [Boolean]  emit_warnings   Whether to call Kernel.warn when
  #                                   warnings are output, best set to
  #                                   false when parsing specification
  #                                   files you've not authored
  #
  # @return [Document]
  def self.load_file(path, emit_warnings: true)
    Document.new(SourceInput::File.new(path), emit_warnings:)
  end

  # For a given string URL this will request the resource and parse it as an
  # OpenAPI document. It will try detect automatically whether the contents
  # are JSON or YAML.
  #
  # @param  [String]  url             URL of the OpenAPI document
  # @param [Boolean]  emit_warnings   Whether to call Kernel.warn when
  #                                   warnings are output, best set to
  #                                   false when parsing specification
  #                                   files you've not authored
  #
  # @return [Document]
  def self.load_url(url, emit_warnings: true)
    Document.new(SourceInput::Url.new(url.to_s), emit_warnings:)
  end
end