class Grape::Middleware::Versioner::Base
Constants
- DEFAULT_OPTIONS
Public Class Methods
Source
# File lib/grape/middleware/versioner/base.rb, line 16 def self.inherited(klass) super Versioner.register(klass) end
Calls superclass method
Public Instance Methods
Source
# File lib/grape/middleware/versioner/base.rb, line 48 def cascade? version_options[:cascade] end
By default those errors contain an ‘X-Cascade` header set to `pass`, which allows nesting and stacking of routes (see Grape::Router
) for more information). To prevent this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
Source
# File lib/grape/middleware/versioner/base.rb, line 60 def error_headers cascade? ? { 'X-Cascade' => 'pass' } : {} end
Source
# File lib/grape/middleware/versioner/base.rb, line 29 def mount_path options[:mount_path] end
Source
# File lib/grape/middleware/versioner/base.rb, line 52 def parameter_key version_options[:parameter] end
Source
# File lib/grape/middleware/versioner/base.rb, line 33 def pattern options[:pattern] end
Source
# File lib/grape/middleware/versioner/base.rb, line 64 def potential_version_match?(potential_version) versions.blank? || versions.any? { |v| v.to_s == potential_version } end
Source
# File lib/grape/middleware/versioner/base.rb, line 25 def prefix options[:prefix] end
Source
# File lib/grape/middleware/versioner/base.rb, line 41 def strict? version_options[:strict] end
Source
# File lib/grape/middleware/versioner/base.rb, line 56 def vendor version_options[:vendor] end
Source
# File lib/grape/middleware/versioner/base.rb, line 68 def version_not_found! throw :error, status: 404, message: '404 API Version Not Found', headers: { 'X-Cascade' => 'pass' } end
Source
# File lib/grape/middleware/versioner/base.rb, line 37 def version_options options[:version_options] end
Source
# File lib/grape/middleware/versioner/base.rb, line 21 def versions options[:versions] end