gitlab-org--gitlab-foss/lib/api/api.rb

155 lines
4.6 KiB
Ruby
Raw Normal View History

module API
2012-06-27 07:32:56 -04:00
class API < Grape::API
2014-12-19 09:15:29 -05:00
include APIGuard
2017-01-30 12:41:56 -05:00
LOG_FILENAME = Rails.root.join("log", "api_json.log")
NO_SLASH_URL_PART_REGEX = %r{[^/]+}
PROJECT_ENDPOINT_REQUIREMENTS = { id: NO_SLASH_URL_PART_REGEX }.freeze
COMMIT_ENDPOINT_REQUIREMENTS = PROJECT_ENDPOINT_REQUIREMENTS.merge(sha: NO_SLASH_URL_PART_REGEX).freeze
insert_before Grape::Middleware::Error,
GrapeLogging::Middleware::RequestLogger,
logger: Logger.new(LOG_FILENAME),
formatter: Gitlab::GrapeLogging::Formatters::LogrageWithTimestamp.new,
include: [
GrapeLogging::Loggers::FilterParameters.new,
GrapeLogging::Loggers::ClientEnv.new,
Gitlab::GrapeLogging::Loggers::UserLogger.new,
Gitlab::GrapeLogging::Loggers::QueueDurationLogger.new
]
allow_access_with_scope :api
prefix :api
2017-01-30 12:41:56 -05:00
version 'v3', using: :path do
2018-05-15 09:39:33 -04:00
route :any, '*path' do
error!('API V3 is no longer supported. Use API V4 instead.', 410)
end
2017-01-30 12:41:56 -05:00
end
2012-07-04 03:48:00 -04:00
2018-05-15 09:39:33 -04:00
version 'v4', using: :path
before do
header['X-Frame-Options'] = 'SAMEORIGIN'
header['X-Content-Type-Options'] = 'nosniff'
end
# The locale is set to the current user's locale when `current_user` is loaded
after { Gitlab::I18n.use_default_locale }
rescue_from Gitlab::Access::AccessDeniedError do
rack_response({ 'message' => '403 Forbidden' }.to_json, 403)
end
2012-07-05 11:12:09 -04:00
rescue_from ActiveRecord::RecordNotFound do
rack_response({ 'message' => '404 Not found' }.to_json, 404)
2012-07-05 11:12:09 -04:00
end
rescue_from UploadedFile::InvalidPathError do |e|
rack_response({ 'message' => e.message }.to_json, 400)
end
rescue_from ObjectStorage::RemoteStoreError do |e|
rack_response({ 'message' => e.message }.to_json, 500)
end
2016-08-02 17:56:27 -04:00
# Retain 405 error rather than a 500 error for Grape 0.15.0+.
# https://github.com/ruby-grape/grape/blob/a3a28f5b5dfbb2797442e006dbffd750b27f2a76/UPGRADING.md#changes-to-method-not-allowed-routes
rescue_from Grape::Exceptions::MethodNotAllowed do |e|
error! e.message, e.status, e.headers
end
2016-08-02 17:56:27 -04:00
rescue_from Grape::Exceptions::Base do |e|
error! e.message, e.status, e.headers
end
rescue_from Gitlab::Auth::TooManyIps do |e|
rack_response({ 'message' => '403 Forbidden' }.to_json, 403)
end
rescue_from :all do |exception|
handle_api_exception(exception)
end
2012-06-27 07:32:56 -04:00
format :json
content_type :txt, "text/plain"
# Ensure the namespace is right, otherwise we might load Grape::API::Helpers
helpers ::SentryHelper
helpers ::API::Helpers
helpers ::API::Helpers::CommonHelpers
2016-09-25 04:28:23 -04:00
# Keep in alphabetical order
mount ::API::AccessRequests
2017-01-04 17:07:49 -05:00
mount ::API::Applications
2018-05-18 04:49:02 -04:00
mount ::API::Avatar
mount ::API::AwardEmoji
2018-03-05 12:51:40 -05:00
mount ::API::Badges
2016-10-13 06:52:51 -04:00
mount ::API::Boards
mount ::API::Branches
mount ::API::BroadcastMessages
2017-05-17 12:17:15 -04:00
mount ::API::CircuitBreakers
mount ::API::Commits
2016-10-13 06:52:51 -04:00
mount ::API::CommitStatuses
mount ::API::DeployKeys
2016-08-16 02:45:23 -04:00
mount ::API::Deployments
2016-07-26 03:37:02 -04:00
mount ::API::Environments
mount ::API::Events
2017-05-31 17:06:01 -04:00
mount ::API::Features
mount ::API::Files
2018-02-19 14:06:16 -05:00
mount ::API::GroupBoards
mount ::API::Groups
2017-12-06 14:07:47 -05:00
mount ::API::GroupMilestones
mount ::API::Internal
mount ::API::Issues
mount ::API::Jobs
mount ::API::JobArtifacts
mount ::API::Keys
mount ::API::Labels
2016-08-24 05:42:48 -04:00
mount ::API::Lint
mount ::API::Markdown
mount ::API::Members
2016-09-25 04:28:23 -04:00
mount ::API::MergeRequestDiffs
2016-10-13 06:52:51 -04:00
mount ::API::MergeRequests
mount ::API::Namespaces
mount ::API::Notes
mount ::API::Discussions
mount ::API::NotificationSettings
2017-08-21 19:59:54 -04:00
mount ::API::PagesDomains
2016-08-17 04:09:42 -04:00
mount ::API::Pipelines
2017-05-11 15:12:04 -04:00
mount ::API::PipelineSchedules
2017-12-02 14:49:01 -05:00
mount ::API::ProjectExport
2018-02-12 06:40:55 -05:00
mount ::API::ProjectImport
mount ::API::ProjectHooks
mount ::API::Projects
2017-12-06 14:07:47 -05:00
mount ::API::ProjectMilestones
mount ::API::ProjectSnapshots
2016-10-13 06:52:51 -04:00
mount ::API::ProjectSnippets
2017-08-02 06:16:17 -04:00
mount ::API::ProtectedBranches
mount ::API::Repositories
2017-02-15 19:30:46 -05:00
mount ::API::Runner
mount ::API::Runners
2018-01-31 09:59:59 -05:00
mount ::API::Search
mount ::API::Services
mount ::API::Settings
mount ::API::SidekiqMetrics
mount ::API::Snippets
mount ::API::Subscriptions
mount ::API::SystemHooks
mount ::API::Tags
2016-05-27 05:00:56 -04:00
mount ::API::Templates
2016-03-11 14:04:42 -05:00
mount ::API::Todos
mount ::API::Triggers
mount ::API::Users
mount ::API::Variables
2017-07-18 08:40:35 -04:00
mount ::API::GroupVariables
2016-10-12 07:32:48 -04:00
mount ::API::Version
2017-09-06 18:21:52 -04:00
mount ::API::Wikis
route :any, '*path' do
error!('404 Not Found', 404)
end
2012-06-27 07:32:56 -04:00
end
2012-06-27 05:26:16 -04:00
end