Merge branch 'add-base-api-class' into 'master'

Add base API class

See merge request gitlab-org/gitlab!45039

.rubocop.yml

@@ -335,7 +335,7 @@ Gitlab/Union:
     - 'spec/**/*'
     - 'ee/spec/**/*'
 
-API/GrapeAPIInstance:
+API/Base:
   Enabled: true
   Include:
     - 'lib/**/api/**/*.rb'

Gemfile

@@ -19,7 +19,7 @@ gem 'default_value_for', '~> 3.3.0'
 gem 'pg', '~> 1.1'
 
 gem 'rugged', '~> 0.28'
-gem 'grape-path-helpers', '~> 1.3'
+gem 'grape-path-helpers', '~> 1.4'
 
 gem 'faraday', '~> 1.0'
 gem 'marginalia', '~> 1.9.0'

Gemfile.lock

@@ -495,7 +495,7 @@ GEM
     grape-entity (0.7.1)
       activesupport (>= 4.0)
       multi_json (>= 1.3.2)
-    grape-path-helpers (1.3.0)
+    grape-path-helpers (1.4.0)
       activesupport
       grape (~> 1.3)
       rake (~> 12)
@@ -1348,7 +1348,7 @@ DEPENDENCIES
   gpgme (~> 2.0.19)
   grape (= 1.4.0)
   grape-entity (~> 0.7.1)
-  grape-path-helpers (~> 1.3)
+  grape-path-helpers (~> 1.4)
   grape_logging (~> 1.7)
   graphiql-rails (~> 1.4.10)
   graphql (~> 1.11.4)

ee/lib/api/analytics/code_review_analytics.rb

@@ -2,7 +2,7 @@
 
 module API
   module Analytics
-    class CodeReviewAnalytics < Grape::API::Instance
+    class CodeReviewAnalytics < ::API::Base
       include PaginationParams
 
       helpers do

ee/lib/api/analytics/group_activity_analytics.rb

@@ -2,7 +2,7 @@
 
 module API
   module Analytics
-    class GroupActivityAnalytics < Grape::API::Instance
+    class GroupActivityAnalytics < ::API::Base
       DESCRIPTION_DETAIL =
         'This feature is gated by the `:group_activity_analytics`'\
         ' feature flag, introduced in GitLab 12.9.'

ee/lib/api/audit_events.rb

 # frozen_string_literal: true
 
 module API
-  class AuditEvents < ::Grape::API::Instance
+  class AuditEvents < ::API::Base
     include ::API::PaginationParams
 
     before do

ee/lib/api/dependencies.rb

 # frozen_string_literal: true
 
 module API
-  class Dependencies < Grape::API::Instance
+  class Dependencies < ::API::Base
     helpers do
       def dependencies_by(params)
         pipeline = ::Security::ReportFetchService.new(user_project, ::Ci::JobArtifact.dependency_list_reports).pipeline

ee/lib/api/dependency_proxy.rb

 # frozen_string_literal: true
 
 module API
-  class DependencyProxy < Grape::API::Instance
+  class DependencyProxy < ::API::Base
     helpers ::API::Helpers::PackagesHelpers
 
     helpers do

ee/lib/api/elasticsearch_indexed_namespaces.rb

 # frozen_string_literal: true
 
 module API
-  class ElasticsearchIndexedNamespaces < Grape::API::Instance
+  class ElasticsearchIndexedNamespaces < ::API::Base
     before { authenticated_as_admin! }
 
     resource :elasticsearch_indexed_namespaces do

ee/lib/api/epic_issues.rb

 # frozen_string_literal: true
 
 module API
-  class EpicIssues < Grape::API::Instance
+  class EpicIssues < ::API::Base
     before do
       authenticate!
       authorize_epics_feature!

ee/lib/api/epic_links.rb

 # frozen_string_literal: true
 
 module API
-  class EpicLinks < Grape::API::Instance
+  class EpicLinks < ::API::Base
     include ::Gitlab::Utils::StrongMemoize
 
     before do

ee/lib/api/epics.rb

 # frozen_string_literal: true
 
 module API
-  class Epics < Grape::API::Instance
+  class Epics < ::API::Base
     include PaginationParams
 
     before do

ee/lib/api/geo.rb

@@ -3,7 +3,7 @@
 require 'base64'
 
 module API
-  class Geo < Grape::API::Instance
+  class Geo < ::API::Base
     resource :geo do
       helpers do
         def sanitized_node_status_params

ee/lib/api/geo_nodes.rb

 # frozen_string_literal: true
 
 module API
-  class GeoNodes < Grape::API::Instance
+  class GeoNodes < ::API::Base
     include PaginationParams
     include APIGuard
     include ::Gitlab::Utils::StrongMemoize

ee/lib/api/geo_replication.rb

 # frozen_string_literal: true
 
 module API
-  class GeoReplication < Grape::API::Instance
+  class GeoReplication < ::API::Base
     include PaginationParams
     include APIGuard
     include ::Gitlab::Utils::StrongMemoize

ee/lib/api/group_hooks.rb

 # frozen_string_literal: true
 
 module API
-  class GroupHooks < Grape::API::Instance
+  class GroupHooks < ::API::Base
     include ::API::PaginationParams
 
     before { authenticate! }

ee/lib/api/group_push_rule.rb

 # frozen_string_literal: true
 
 module API
-  class GroupPushRule < Grape::API::Instance
+  class GroupPushRule < ::API::Base
     before { authenticate! }
     before { check_group_push_rule_access! }
     before { authorize_change_param(user_group, :commit_committer_check, :reject_unsigned_commits) }

ee/lib/api/ldap.rb

 # frozen_string_literal: true
 
 module API
-  class Ldap < Grape::API::Instance
+  class Ldap < ::API::Base
     # Admin users by default should be able to access these API endpoints.
     # However, non-admin users can access these endpoints if the "Allow group
     # owners to manage LDAP-related group settings" is enabled, and they own a

ee/lib/api/ldap_group_links.rb

 # frozen_string_literal: true
 
 module API
-  class LdapGroupLinks < Grape::API::Instance
+  class LdapGroupLinks < ::API::Base
     before { authenticate! }
 
     params do

ee/lib/api/license.rb

 # frozen_string_literal: true
 
 module API
-  class License < Grape::API::Instance
+  class License < ::API::Base
     before { authenticated_as_admin! }
 
     resource :license do

ee/lib/api/managed_licenses.rb

 # frozen_string_literal: true
 
 module API
-  class ManagedLicenses < Grape::API::Instance
+  class ManagedLicenses < ::API::Base
     include PaginationParams
 
     before { authenticate! unless route.settings[:skip_authentication] }

ee/lib/api/merge_request_approval_rules.rb

 # frozen_string_literal: true
 
 module API
-  class MergeRequestApprovalRules < ::Grape::API
+  class MergeRequestApprovalRules < ::API::Base
     before { authenticate_non_get! }
 
     helpers do

ee/lib/api/merge_trains.rb

 # frozen_string_literal: true
 
 module API
-  class MergeTrains < ::Grape::API::Instance
+  class MergeTrains < ::API::Base
     include PaginationParams
 
     before do

ee/lib/api/personal_access_tokens.rb

 # frozen_string_literal: true
 
 module API
-  class PersonalAccessTokens < Grape::API::Instance
+  class PersonalAccessTokens < ::API::Base
     include ::API::PaginationParams
 
     desc 'Get all Personal Access Tokens' do

ee/lib/api/project_aliases.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectAliases < Grape::API::Instance
+  class ProjectAliases < ::API::Base
     include PaginationParams
 
     before { check_feature_availability }

ee/lib/api/project_approval_rules.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectApprovalRules < ::Grape::API::Instance
+  class ProjectApprovalRules < ::API::Base
     before { authenticate! }
 
     helpers ::API::Helpers::ProjectApprovalRulesHelpers

ee/lib/api/project_approval_settings.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectApprovalSettings < ::Grape::API::Instance
+  class ProjectApprovalSettings < ::API::Base
     before { authenticate! }
 
     helpers ::API::Helpers::ProjectApprovalRulesHelpers

ee/lib/api/project_approvals.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectApprovals < ::Grape::API::Instance
+  class ProjectApprovals < ::API::Base
     before { authenticate! }
     before { authorize! :update_approvers, user_project }
 

ee/lib/api/project_mirror.rb

@@ -3,7 +3,7 @@
 require_dependency 'declarative_policy'
 
 module API
-  class ProjectMirror < Grape::API::Instance
+  class ProjectMirror < ::API::Base
     helpers do
       def github_webhook_signature
         @github_webhook_signature ||= headers['X-Hub-Signature']

ee/lib/api/project_push_rule.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectPushRule < Grape::API::Instance
+  class ProjectPushRule < ::API::Base
     before { authenticate! }
     before { authorize_admin_project }
     before { check_project_feature_available!(:push_rules) }

ee/lib/api/protected_environments.rb

 # frozen_string_literal: true
 
 module API
-  class ProtectedEnvironments < Grape::API::Instance
+  class ProtectedEnvironments < ::API::Base
     include PaginationParams
 
     ENVIRONMENT_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(name: API::NO_SLASH_URL_PART_REGEX)

ee/lib/api/resource_iteration_events.rb

 # frozen_string_literal: true
 
 module API
-  class ResourceIterationEvents < Grape::API::Instance
+  class ResourceIterationEvents < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

ee/lib/api/resource_weight_events.rb

 # frozen_string_literal: true
 
 module API
-  class ResourceWeightEvents < Grape::API::Instance
+  class ResourceWeightEvents < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

ee/lib/api/scim.rb

 # frozen_string_literal: true
 
 module API
-  class Scim < Grape::API::Instance
+  class Scim < ::API::Base
     include ::Gitlab::Utils::StrongMemoize
 
     prefix 'api/scim'

ee/lib/api/visual_review_discussions.rb

 # frozen_string_literal: true
 
 module API
-  class VisualReviewDiscussions < Grape::API::Instance
+  class VisualReviewDiscussions < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
     helpers ::RendersNotes

ee/lib/api/vulnerabilities.rb

 # frozen_string_literal: true
 
 module API
-  class Vulnerabilities < Grape::API::Instance
+  class Vulnerabilities < ::API::Base
     include ::API::Helpers::VulnerabilitiesHooks
     include PaginationParams
 

ee/lib/api/vulnerability_exports.rb

 # frozen_string_literal: true
 
 module API
-  class VulnerabilityExports < Grape::API::Instance
+  class VulnerabilityExports < ::API::Base
     include ::API::Helpers::VulnerabilitiesHooks
     include ::Gitlab::Utils::StrongMemoize
 

ee/lib/api/vulnerability_findings.rb

 # frozen_string_literal: true
 
 module API
-  class VulnerabilityFindings < Grape::API::Instance
+  class VulnerabilityFindings < ::API::Base
     include PaginationParams
     include ::Gitlab::Utils::StrongMemoize
 

ee/lib/api/vulnerability_issue_links.rb

 # frozen_string_literal: true
 
 module API
-  class VulnerabilityIssueLinks < Grape::API::Instance
+  class VulnerabilityIssueLinks < ::API::Base
     include ::API::Helpers::VulnerabilitiesHooks
 
     helpers ::API::Helpers::VulnerabilitiesHelpers

ee/lib/ee/api/boards.rb

@@ -2,7 +2,7 @@
 
 module EE
   module API
-    class Boards < ::Grape::API::Instance
+    class Boards < ::API::Base
       include ::API::PaginationParams
       include ::API::BoardsResponses
 

ee/lib/ee/api/group_boards.rb

@@ -2,7 +2,7 @@
 
 module EE
   module API
-    class GroupBoards < ::Grape::API::Instance
+    class GroupBoards < ::API::Base
       include ::API::PaginationParams
       include ::API::BoardsResponses
 

lib/api/access_requests.rb

 # frozen_string_literal: true
 
 module API
-  class AccessRequests < Grape::API::Instance
+  class AccessRequests < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/admin/ci/variables.rb

@@ -3,7 +3,7 @@
 module API
   module Admin
     module Ci
-      class Variables < Grape::API::Instance
+      class Variables < ::API::Base
         include PaginationParams
 
         before { authenticated_as_admin! }

lib/api/admin/instance_clusters.rb

@@ -2,7 +2,7 @@
 
 module API
   module Admin
-    class InstanceClusters < Grape::API::Instance
+    class InstanceClusters < ::API::Base
       include PaginationParams
 
       before do

lib/api/admin/sidekiq.rb

@@ -2,7 +2,7 @@
 
 module API
   module Admin
-    class Sidekiq < Grape::API::Instance
+    class Sidekiq < ::API::Base
       before { authenticated_as_admin! }
 
       namespace 'admin' do

lib/api/api.rb

 # frozen_string_literal: true
 
 module API
-  class API < Grape::API::Instance
+  class API < ::API::Base
     include APIGuard
 
     LOG_FILENAME = Rails.root.join("log", "api_json.log")

lib/api/appearance.rb

 # frozen_string_literal: true
 
 module API
-  class Appearance < Grape::API::Instance
+  class Appearance < ::API::Base
     before { authenticated_as_admin! }
 
     helpers do

lib/api/applications.rb

@@ -2,7 +2,7 @@
 
 module API
   # External applications API
-  class Applications < Grape::API::Instance
+  class Applications < ::API::Base
     before { authenticated_as_admin! }
 
     resource :applications do

lib/api/avatar.rb

 # frozen_string_literal: true
 
 module API
-  class Avatar < Grape::API::Instance
+  class Avatar < ::API::Base
     resource :avatar do
       desc 'Return avatar url for a user' do
         success Entities::Avatar

lib/api/award_emoji.rb

 # frozen_string_literal: true
 
 module API
-  class AwardEmoji < Grape::API::Instance
+  class AwardEmoji < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/badges.rb

 # frozen_string_literal: true
 
 module API
-  class Badges < Grape::API::Instance
+  class Badges < ::API::Base
     include PaginationParams
 
     before { authenticate_non_get! }

lib/api/base.rb

+# frozen_string_literal: true
+
+module API
+  class Base < Grape::API::Instance # rubocop:disable API/Base
+  end
+end

lib/api/boards.rb

 # frozen_string_literal: true
 
 module API
-  class Boards < Grape::API::Instance
+  class Boards < ::API::Base
     include BoardsResponses
     include PaginationParams
 

lib/api/branches.rb

@@ -3,7 +3,7 @@
 require 'mime/types'
 
 module API
-  class Branches < Grape::API::Instance
+  class Branches < ::API::Base
     include PaginationParams
 
     BRANCH_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(branch: API::NO_SLASH_URL_PART_REGEX)

lib/api/broadcast_messages.rb

 # frozen_string_literal: true
 
 module API
-  class BroadcastMessages < Grape::API::Instance
+  class BroadcastMessages < ::API::Base
     include PaginationParams
 
     resource :broadcast_messages do

lib/api/ci/pipeline_schedules.rb

@@ -2,7 +2,7 @@
 
 module API
   module Ci
-    class PipelineSchedules < Grape::API::Instance
+    class PipelineSchedules < ::API::Base
       include PaginationParams
 
       before { authenticate! }

lib/api/ci/pipelines.rb

@@ -2,7 +2,7 @@
 
 module API
   module Ci
-    class Pipelines < Grape::API::Instance
+    class Pipelines < ::API::Base
       include PaginationParams
 
       before { authenticate_non_get! }

lib/api/ci/runner.rb

@@ -2,7 +2,7 @@
 
 module API
   module Ci
-    class Runner < Grape::API::Instance
+    class Runner < ::API::Base
       helpers ::API::Helpers::Runner
 
       resource :runners do

lib/api/ci/runners.rb

@@ -2,7 +2,7 @@
 
 module API
   module Ci
-    class Runners < Grape::API::Instance
+    class Runners < ::API::Base
       include PaginationParams
 
       before { authenticate! }

lib/api/commit_statuses.rb

@@ -3,7 +3,7 @@
 require 'mime/types'
 
 module API
-  class CommitStatuses < Grape::API::Instance
+  class CommitStatuses < ::API::Base
     params do
       requires :id, type: String, desc: 'The ID of a project'
     end

lib/api/commits.rb

@@ -3,7 +3,7 @@
 require 'mime/types'
 
 module API
-  class Commits < Grape::API::Instance
+  class Commits < ::API::Base
     include PaginationParams
 
     before do

lib/api/composer_packages.rb

@@ -2,7 +2,7 @@
 
 # PHP composer support (https://getcomposer.org/)
 module API
-  class ComposerPackages < Grape::API::Instance
+  class ComposerPackages < ::API::Base
     helpers ::API::Helpers::PackagesManagerClientsHelpers
     helpers ::API::Helpers::RelatedResourcesHelpers
     helpers ::API::Helpers::Packages::BasicAuthHelpers

lib/api/conan_instance_packages.rb

@@ -2,7 +2,7 @@
 
 # Conan Instance-Level Package Manager Client API
 module API
-  class ConanInstancePackages < Grape::API::Instance
+  class ConanInstancePackages < ::API::Base
     namespace 'packages/conan/v1' do
       include ConanPackageEndpoints
     end

lib/api/conan_project_packages.rb

@@ -2,7 +2,7 @@
 
 # Conan Project-Level Package Manager Client API
 module API
-  class ConanProjectPackages < Grape::API::Instance
+  class ConanProjectPackages < ::API::Base
     params do
       requires :id, type: Integer, desc: 'The ID of a project', regexp: %r{\A[1-9]\d*\z}
     end

lib/api/container_registry_event.rb

 # frozen_string_literal: true
 
 module API
-  class ContainerRegistryEvent < Grape::API::Instance
+  class ContainerRegistryEvent < ::API::Base
     DOCKER_DISTRIBUTION_EVENTS_V1_JSON = 'application/vnd.docker.distribution.events.v1+json'
 
     before { authenticate_registry_notification! }

lib/api/debian_group_packages.rb

 # frozen_string_literal: true
 
 module API
-  class DebianGroupPackages < Grape::API::Instance
+  class DebianGroupPackages < ::API::Base
     params do
       requires :id, type: String, desc: 'The ID of a group'
     end

lib/api/debian_project_packages.rb

 # frozen_string_literal: true
 
 module API
-  class DebianProjectPackages < Grape::API::Instance
+  class DebianProjectPackages < ::API::Base
     params do
       requires :id, type: String, desc: 'The ID of a project'
     end

lib/api/deploy_keys.rb

 # frozen_string_literal: true
 
 module API
-  class DeployKeys < Grape::API::Instance
+  class DeployKeys < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/deploy_tokens.rb

 # frozen_string_literal: true
 
 module API
-  class DeployTokens < Grape::API::Instance
+  class DeployTokens < ::API::Base
     include PaginationParams
 
     helpers do

lib/api/deployments.rb

@@ -2,7 +2,7 @@
 
 module API
   # Deployments RESTful API endpoints
-  class Deployments < Grape::API::Instance
+  class Deployments < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/discussions.rb

 # frozen_string_literal: true
 
 module API
-  class Discussions < Grape::API::Instance
+  class Discussions < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
     helpers ::RendersNotes

lib/api/environments.rb

@@ -2,7 +2,7 @@
 
 module API
   # Environments RESTfull API endpoints
-  class Environments < Grape::API::Instance
+  class Environments < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/error_tracking.rb

 # frozen_string_literal: true
 
 module API
-  class ErrorTracking < Grape::API::Instance
+  class ErrorTracking < ::API::Base
     before { authenticate! }
 
     params do

lib/api/events.rb

 # frozen_string_literal: true
 
 module API
-  class Events < Grape::API::Instance
+  class Events < ::API::Base
     include PaginationParams
     include APIGuard
     helpers ::API::Helpers::EventsHelpers

lib/api/feature_flag_scopes.rb

 # frozen_string_literal: true
 
 module API
-  class FeatureFlagScopes < Grape::API::Instance
+  class FeatureFlagScopes < ::API::Base
     include PaginationParams
 
     ENVIRONMENT_SCOPE_ENDPOINT_REQUIREMENTS = FeatureFlags::FEATURE_FLAG_ENDPOINT_REQUIREMENTS

lib/api/feature_flags.rb

 # frozen_string_literal: true
 
 module API
-  class FeatureFlags < Grape::API::Instance
+  class FeatureFlags < ::API::Base
     include PaginationParams
 
     FEATURE_FLAG_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS

lib/api/feature_flags_user_lists.rb

 # frozen_string_literal: true
 
 module API
-  class FeatureFlagsUserLists < Grape::API::Instance
+  class FeatureFlagsUserLists < ::API::Base
     include PaginationParams
 
     error_formatter :json, -> (message, _backtrace, _options, _env, _original_exception) {

lib/api/features.rb

 # frozen_string_literal: true
 
 module API
-  class Features < Grape::API::Instance
+  class Features < ::API::Base
     before { authenticated_as_admin! }
 
     helpers do

lib/api/files.rb

 # frozen_string_literal: true
 
 module API
-  class Files < Grape::API::Instance
+  class Files < ::API::Base
     include APIGuard
 
     FILE_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(file_path: API::NO_SLASH_URL_PART_REGEX)

lib/api/freeze_periods.rb

 # frozen_string_literal: true
 
 module API
-  class FreezePeriods < Grape::API::Instance
+  class FreezePeriods < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/generic_packages.rb

 # frozen_string_literal: true
 
 module API
-  class GenericPackages < Grape::API::Instance
+  class GenericPackages < ::API::Base
     GENERIC_PACKAGES_REQUIREMENTS = {
       package_name: API::NO_SLASH_URL_PART_REGEX,
       file_name: API::NO_SLASH_URL_PART_REGEX

lib/api/go_proxy.rb

 # frozen_string_literal: true
 module API
-  class GoProxy < Grape::API::Instance
+  class GoProxy < ::API::Base
     helpers Gitlab::Golang
     helpers ::API::Helpers::PackagesHelpers
 

lib/api/group_boards.rb

 # frozen_string_literal: true
 
 module API
-  class GroupBoards < Grape::API::Instance
+  class GroupBoards < ::API::Base
     include BoardsResponses
     include PaginationParams
 

lib/api/group_clusters.rb

 # frozen_string_literal: true
 
 module API
-  class GroupClusters < Grape::API::Instance
+  class GroupClusters < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/group_container_repositories.rb

 # frozen_string_literal: true
 
 module API
-  class GroupContainerRepositories < Grape::API::Instance
+  class GroupContainerRepositories < ::API::Base
     include PaginationParams
 
     helpers ::API::Helpers::PackagesHelpers

lib/api/group_export.rb

 # frozen_string_literal: true
 
 module API
-  class GroupExport < Grape::API::Instance
+  class GroupExport < ::API::Base
     helpers Helpers::RateLimiter
 
     before do

lib/api/group_import.rb

 # frozen_string_literal: true
 
 module API
-  class GroupImport < Grape::API::Instance
+  class GroupImport < ::API::Base
     helpers Helpers::FileUploadHelpers
 
     helpers do

lib/api/group_labels.rb

 # frozen_string_literal: true
 
 module API
-  class GroupLabels < Grape::API::Instance
+  class GroupLabels < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::LabelHelpers
 

lib/api/group_milestones.rb

 # frozen_string_literal: true
 
 module API
-  class GroupMilestones < Grape::API::Instance
+  class GroupMilestones < ::API::Base
     include MilestoneResponses
     include PaginationParams
 

lib/api/group_packages.rb

 # frozen_string_literal: true
 
 module API
-  class GroupPackages < Grape::API::Instance
+  class GroupPackages < ::API::Base
     include PaginationParams
 
     before do

lib/api/group_variables.rb

 # frozen_string_literal: true
 
 module API
-  class GroupVariables < Grape::API::Instance
+  class GroupVariables < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/groups.rb

 # frozen_string_literal: true
 
 module API
-  class Groups < Grape::API::Instance
+  class Groups < ::API::Base
     include PaginationParams
     include Helpers::CustomAttributes
 

lib/api/import_bitbucket_server.rb

 # frozen_string_literal: true
 
 module API
-  class ImportBitbucketServer < Grape::API::Instance
+  class ImportBitbucketServer < ::API::Base
     helpers do
       def client
         @client ||= BitbucketServer::Client.new(credentials)

lib/api/import_github.rb

 # frozen_string_literal: true
 
 module API
-  class ImportGithub < Grape::API::Instance
+  class ImportGithub < ::API::Base
     rescue_from Octokit::Unauthorized, with: :provider_unauthorized
 
     before do

lib/api/internal/base.rb

@@ -3,7 +3,7 @@
 module API
   # Internal access API
   module Internal
-    class Base < Grape::API::Instance
+    class Base < ::API::Base
       before { authenticate_by_gitlab_shell_token! }
 
       before do

lib/api/internal/kubernetes.rb

@@ -3,7 +3,7 @@
 module API
   # Kubernetes Internal API
   module Internal
-    class Kubernetes < Grape::API::Instance
+    class Kubernetes < ::API::Base
       before do
         check_feature_enabled
         authenticate_gitlab_kas_request!

lib/api/internal/lfs.rb

@@ -2,7 +2,7 @@
 
 module API
   module Internal
-    class Lfs < Grape::API::Instance
+    class Lfs < ::API::Base
       use Rack::Sendfile
 
       before { authenticate_by_gitlab_shell_token! }

lib/api/internal/pages.rb

@@ -3,7 +3,7 @@
 module API
   # Pages Internal API
   module Internal
-    class Pages < Grape::API::Instance
+    class Pages < ::API::Base
       before do
         authenticate_gitlab_pages_request!
       end

lib/api/issue_links.rb

 # frozen_string_literal: true
 
 module API
-  class IssueLinks < Grape::API::Instance
+  class IssueLinks < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/issues.rb

 # frozen_string_literal: true
 
 module API
-  class Issues < Grape::API::Instance
+  class Issues < ::API::Base
     include PaginationParams
     helpers Helpers::IssuesHelpers
     helpers Helpers::RateLimiter

lib/api/job_artifacts.rb

 # frozen_string_literal: true
 
 module API
-  class JobArtifacts < Grape::API::Instance
+  class JobArtifacts < ::API::Base
     before { authenticate_non_get! }
 
     # EE::API::JobArtifacts would override the following helpers

lib/api/jobs.rb

 # frozen_string_literal: true
 
 module API
-  class Jobs < Grape::API::Instance
+  class Jobs < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/keys.rb

@@ -2,7 +2,7 @@
 
 module API
   # Keys API
-  class Keys < Grape::API::Instance
+  class Keys < ::API::Base
     before { authenticate! }
 
     resource :keys do

lib/api/labels.rb

 # frozen_string_literal: true
 
 module API
-  class Labels < Grape::API::Instance
+  class Labels < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::LabelHelpers
 

lib/api/lint.rb

 # frozen_string_literal: true
 
 module API
-  class Lint < Grape::API::Instance
+  class Lint < ::API::Base
     namespace :ci do
       desc 'Validation of .gitlab-ci.yml content'
       params do

lib/api/markdown.rb

 # frozen_string_literal: true
 
 module API
-  class Markdown < Grape::API::Instance
+  class Markdown < ::API::Base
     params do
       requires :text, type: String, desc: "The markdown text to render"
       optional :gfm, type: Boolean, desc: "Render text using GitLab Flavored Markdown"

lib/api/maven_packages.rb

 # frozen_string_literal: true
 module API
-  class MavenPackages < Grape::API::Instance
+  class MavenPackages < ::API::Base
     MAVEN_ENDPOINT_REQUIREMENTS = {
       file_name: API::NO_SLASH_URL_PART_REGEX
     }.freeze

lib/api/members.rb

 # frozen_string_literal: true
 
 module API
-  class Members < Grape::API::Instance
+  class Members < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/merge_request_approvals.rb

 # frozen_string_literal: true
 
 module API
-  class MergeRequestApprovals < ::Grape::API::Instance
+  class MergeRequestApprovals < ::API::Base
     before { authenticate_non_get! }
 
     helpers do

lib/api/merge_request_diffs.rb

@@ -2,7 +2,7 @@
 
 module API
   # MergeRequestDiff API
-  class MergeRequestDiffs < Grape::API::Instance
+  class MergeRequestDiffs < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/merge_requests.rb

 # frozen_string_literal: true
 
 module API
-  class MergeRequests < Grape::API::Instance
+  class MergeRequests < ::API::Base
     include PaginationParams
 
     CONTEXT_COMMITS_POST_LIMIT = 20

lib/api/metrics/dashboard/annotations.rb

@@ -3,7 +3,7 @@
 module API
   module Metrics
     module Dashboard
-      class Annotations < Grape::API::Instance
+      class Annotations < ::API::Base
         desc 'Create a new monitoring dashboard annotation' do
           success Entities::Metrics::Dashboard::Annotation
         end

lib/api/metrics/user_starred_dashboards.rb

@@ -2,7 +2,7 @@
 
 module API
   module Metrics
-    class UserStarredDashboards < Grape::API::Instance
+    class UserStarredDashboards < ::API::Base
       resource :projects do
         desc 'Marks selected metrics dashboard as starred' do
           success Entities::Metrics::UserStarredDashboard

lib/api/namespaces.rb

 # frozen_string_literal: true
 
 module API
-  class Namespaces < Grape::API::Instance
+  class Namespaces < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/notes.rb

 # frozen_string_literal: true
 
 module API
-  class Notes < Grape::API::Instance
+  class Notes < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

lib/api/notification_settings.rb

@@ -2,7 +2,7 @@
 
 module API
   # notification_settings API
-  class NotificationSettings < Grape::API::Instance
+  class NotificationSettings < ::API::Base
     before { authenticate! }
 
     helpers ::API::Helpers::MembersHelpers

lib/api/npm_packages.rb

 # frozen_string_literal: true
 module API
-  class NpmPackages < Grape::API::Instance
+  class NpmPackages < ::API::Base
     helpers ::API::Helpers::PackagesHelpers
     helpers ::API::Helpers::Packages::DependencyProxyHelpers
 

lib/api/nuget_packages.rb

@@ -6,7 +6,7 @@
 # called by the NuGet package manager client when users run commands
 # like `nuget install` or `nuget push`.
 module API
-  class NugetPackages < Grape::API::Instance
+  class NugetPackages < ::API::Base
     helpers ::API::Helpers::PackagesManagerClientsHelpers
     helpers ::API::Helpers::Packages::BasicAuthHelpers
 

lib/api/package_files.rb

 # frozen_string_literal: true
 
 module API
-  class PackageFiles < Grape::API::Instance
+  class PackageFiles < ::API::Base
     include PaginationParams
 
     before do

lib/api/pages.rb

 # frozen_string_literal: true
 
 module API
-  class Pages < Grape::API::Instance
+  class Pages < ::API::Base
     before do
       require_pages_config_enabled!
       authenticated_with_can_read_all_resources!

lib/api/pages_domains.rb

 # frozen_string_literal: true
 
 module API
-  class PagesDomains < Grape::API::Instance
+  class PagesDomains < ::API::Base
     include PaginationParams
 
     PAGES_DOMAINS_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(domain: API::NO_SLASH_URL_PART_REGEX)

lib/api/project_clusters.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectClusters < Grape::API::Instance
+  class ProjectClusters < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/project_container_repositories.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectContainerRepositories < Grape::API::Instance
+  class ProjectContainerRepositories < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::PackagesHelpers
 

lib/api/project_events.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectEvents < Grape::API::Instance
+  class ProjectEvents < ::API::Base
     include PaginationParams
     include APIGuard
     helpers ::API::Helpers::EventsHelpers

lib/api/project_export.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectExport < Grape::API::Instance
+  class ProjectExport < ::API::Base
     helpers Helpers::RateLimiter
 
     before do

lib/api/project_hooks.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectHooks < Grape::API::Instance
+  class ProjectHooks < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/project_import.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectImport < Grape::API::Instance
+  class ProjectImport < ::API::Base
     include PaginationParams
 
     helpers Helpers::ProjectsHelpers

lib/api/project_milestones.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectMilestones < Grape::API::Instance
+  class ProjectMilestones < ::API::Base
     include PaginationParams
     include MilestoneResponses
 

lib/api/project_packages.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectPackages < Grape::API::Instance
+  class ProjectPackages < ::API::Base
     include PaginationParams
 
     before do

lib/api/project_repository_storage_moves.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectRepositoryStorageMoves < Grape::API::Instance
+  class ProjectRepositoryStorageMoves < ::API::Base
     include PaginationParams
 
     before { authenticated_as_admin! }

lib/api/project_snapshots.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectSnapshots < Grape::API::Instance
+  class ProjectSnapshots < ::API::Base
     helpers ::API::Helpers::ProjectSnapshotsHelpers
 
     before { authorize_read_git_snapshot! }

lib/api/project_snippets.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectSnippets < Grape::API::Instance
+  class ProjectSnippets < ::API::Base
     include PaginationParams
 
     before { check_snippets_enabled }

lib/api/project_statistics.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectStatistics < Grape::API::Instance
+  class ProjectStatistics < ::API::Base
     before do
       authenticate!
       authorize! :daily_statistics, user_project

lib/api/project_templates.rb

 # frozen_string_literal: true
 
 module API
-  class ProjectTemplates < Grape::API::Instance
+  class ProjectTemplates < ::API::Base
     include PaginationParams
 
     TEMPLATE_TYPES = %w[dockerfiles gitignores gitlab_ci_ymls licenses metrics_dashboard_ymls issues merge_requests].freeze

lib/api/projects.rb

@@ -3,7 +3,7 @@
 require_dependency 'declarative_policy'
 
 module API
-  class Projects < Grape::API::Instance
+  class Projects < ::API::Base
     include PaginationParams
     include Helpers::CustomAttributes
 

lib/api/protected_branches.rb

 # frozen_string_literal: true
 
 module API
-  class ProtectedBranches < Grape::API::Instance
+  class ProtectedBranches < ::API::Base
     include PaginationParams
 
     BRANCH_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(name: API::NO_SLASH_URL_PART_REGEX)

lib/api/protected_tags.rb

 # frozen_string_literal: true
 
 module API
-  class ProtectedTags < Grape::API::Instance
+  class ProtectedTags < ::API::Base
     include PaginationParams
 
     TAG_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(name: API::NO_SLASH_URL_PART_REGEX)

lib/api/pypi_packages.rb

@@ -6,7 +6,7 @@
 # called by the PyPI package manager client when users run commands
 # like `pip install` or `twine upload`.
 module API
-  class PypiPackages < Grape::API::Instance
+  class PypiPackages < ::API::Base
     helpers ::API::Helpers::PackagesManagerClientsHelpers
     helpers ::API::Helpers::RelatedResourcesHelpers
     helpers ::API::Helpers::Packages::BasicAuthHelpers

lib/api/release/links.rb

@@ -2,7 +2,7 @@
 
 module API
   module Release
-    class Links < Grape::API::Instance
+    class Links < ::API::Base
       include PaginationParams
 
       RELEASE_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS

lib/api/releases.rb

 # frozen_string_literal: true
 
 module API
-  class Releases < Grape::API::Instance
+  class Releases < ::API::Base
     include PaginationParams
 
     RELEASE_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS

lib/api/remote_mirrors.rb

 # frozen_string_literal: true
 
 module API
-  class RemoteMirrors < Grape::API::Instance
+  class RemoteMirrors < ::API::Base
     include PaginationParams
 
     before do

lib/api/repositories.rb

@@ -3,7 +3,7 @@
 require 'mime/types'
 
 module API
-  class Repositories < Grape::API::Instance
+  class Repositories < ::API::Base
     include PaginationParams
 
     helpers ::API::Helpers::HeadersHelpers

lib/api/resource_label_events.rb

 # frozen_string_literal: true
 
 module API
-  class ResourceLabelEvents < Grape::API::Instance
+  class ResourceLabelEvents < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

lib/api/resource_milestone_events.rb

 # frozen_string_literal: true
 
 module API
-  class ResourceMilestoneEvents < Grape::API::Instance
+  class ResourceMilestoneEvents < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

lib/api/resource_state_events.rb

 # frozen_string_literal: true
 
 module API
-  class ResourceStateEvents < Grape::API::Instance
+  class ResourceStateEvents < ::API::Base
     include PaginationParams
     helpers ::API::Helpers::NotesHelpers
 

lib/api/search.rb

 # frozen_string_literal: true
 
 module API
-  class Search < Grape::API::Instance
+  class Search < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/services.rb

 # frozen_string_literal: true
 module API
-  class Services < Grape::API::Instance
+  class Services < ::API::Base
     services = Helpers::ServicesHelpers.services
     service_classes = Helpers::ServicesHelpers.service_classes
 

lib/api/settings.rb

 # frozen_string_literal: true
 
 module API
-  class Settings < Grape::API::Instance
+  class Settings < ::API::Base
     before { authenticated_as_admin! }
 
     helpers Helpers::SettingsHelpers

lib/api/sidekiq_metrics.rb

@@ -3,7 +3,7 @@
 require 'sidekiq/api'
 
 module API
-  class SidekiqMetrics < Grape::API::Instance
+  class SidekiqMetrics < ::API::Base
     before { authenticated_as_admin! }
 
     helpers do

lib/api/snippets.rb

@@ -2,7 +2,7 @@
 
 module API
   # Snippets API
-  class Snippets < Grape::API::Instance
+  class Snippets < ::API::Base
     include PaginationParams
 
     resource :snippets do

lib/api/statistics.rb

 # frozen_string_literal: true
 
 module API
-  class Statistics < Grape::API::Instance
+  class Statistics < ::API::Base
     before { authenticated_as_admin! }
 
     COUNTED_ITEMS = [Project, User, Group, ForkNetworkMember, ForkNetwork, Issue,

lib/api/submodules.rb

 # frozen_string_literal: true
 
 module API
-  class Submodules < Grape::API::Instance
+  class Submodules < ::API::Base
     before { authenticate! }
 
     helpers do

lib/api/subscriptions.rb

 # frozen_string_literal: true
 
 module API
-  class Subscriptions < Grape::API::Instance
+  class Subscriptions < ::API::Base
     helpers ::API::Helpers::LabelHelpers
 
     before { authenticate! }

lib/api/suggestions.rb

 # frozen_string_literal: true
 
 module API
-  class Suggestions < Grape::API::Instance
+  class Suggestions < ::API::Base
     before { authenticate! }
 
     resource :suggestions do

lib/api/system_hooks.rb

 # frozen_string_literal: true
 
 module API
-  class SystemHooks < Grape::API::Instance
+  class SystemHooks < ::API::Base
     include PaginationParams
 
     before do

lib/api/tags.rb

 # frozen_string_literal: true
 
 module API
-  class Tags < Grape::API::Instance
+  class Tags < ::API::Base
     include PaginationParams
 
     TAG_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(tag_name: API::NO_SLASH_URL_PART_REGEX)

lib/api/templates.rb

 # frozen_string_literal: true
 
 module API
-  class Templates < Grape::API::Instance
+  class Templates < ::API::Base
     include PaginationParams
 
     GLOBAL_TEMPLATE_TYPES = {

lib/api/terraform/state.rb

@@ -4,7 +4,7 @@ require_dependency 'api/validations/validators/limit'
 
 module API
   module Terraform
-    class State < Grape::API::Instance
+    class State < ::API::Base
       include ::Gitlab::Utils::StrongMemoize
 
       default_format :json

lib/api/terraform/state_version.rb

@@ -2,7 +2,7 @@
 
 module API
   module Terraform
-    class StateVersion < Grape::API::Instance
+    class StateVersion < ::API::Base
       default_format :json
 
       before do

lib/api/todos.rb

 # frozen_string_literal: true
 
 module API
-  class Todos < Grape::API::Instance
+  class Todos < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/triggers.rb

 # frozen_string_literal: true
 
 module API
-  class Triggers < Grape::API::Instance
+  class Triggers < ::API::Base
     include PaginationParams
 
     HTTP_GITLAB_EVENT_HEADER = "HTTP_#{WebHookService::GITLAB_EVENT_HEADER}".underscore.upcase

lib/api/unleash.rb

 # frozen_string_literal: true
 
 module API
-  class Unleash < Grape::API::Instance
+  class Unleash < ::API::Base
     include PaginationParams
 
     namespace :feature_flags do

lib/api/usage_data.rb

 # frozen_string_literal: true
 
 module API
-  class UsageData < Grape::API::Instance
+  class UsageData < ::API::Base
     before { authenticate! }
 
     namespace 'usage_data' do

lib/api/user_counts.rb

 # frozen_string_literal: true
 
 module API
-  class UserCounts < Grape::API::Instance
+  class UserCounts < ::API::Base
     resource :user_counts do
       desc 'Return the user specific counts' do
         detail 'Open MR Count'

lib/api/users.rb

 # frozen_string_literal: true
 
 module API
-  class Users < Grape::API::Instance
+  class Users < ::API::Base
     include PaginationParams
     include APIGuard
     include Helpers::CustomAttributes

lib/api/v3/github.rb

@@ -7,7 +7,7 @@
 #
 module API
   module V3
-    class Github < Grape::API::Instance
+    class Github < ::API::Base
       NO_SLASH_URL_PART_REGEX = %r{[^/]+}.freeze
       ENDPOINT_REQUIREMENTS = {
         namespace: NO_SLASH_URL_PART_REGEX,

lib/api/variables.rb

 # frozen_string_literal: true
 
 module API
-  class Variables < Grape::API::Instance
+  class Variables < ::API::Base
     include PaginationParams
 
     before { authenticate! }

lib/api/version.rb

 # frozen_string_literal: true
 
 module API
-  class Version < Grape::API::Instance
+  class Version < ::API::Base
     helpers ::API::Helpers::GraphqlHelpers
     include APIGuard
 

lib/api/wikis.rb

 # frozen_string_literal: true
 
 module API
-  class Wikis < Grape::API::Instance
+  class Wikis < ::API::Base
     helpers ::API::Helpers::WikisHelpers
 
     helpers do

rubocop/cop/api/grape_api_instance.rb → rubocop/cop/api/base.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module API
-      class GrapeAPIInstance < RuboCop::Cop::Cop
-        # This cop checks that APIs subclass Grape::API::Instance with Grape v1.3+.
+      class Base < RuboCop::Cop::Cop
+        # This cop checks that APIs subclass API::Base.
         #
         # @example
         #
@@ -14,19 +14,24 @@ module RuboCop
         #   end
         # end
         #
-        # # good
         # module API
         #   class Projects < Grape::API::Instance
         #   end
         # end
-        MSG = 'Inherit from Grape::API::Instance instead of Grape::API. ' \
-              'For more details check the https://gitlab.com/gitlab-org/gitlab/-/issues/215230.'
+        #
+        # # good
+        # module API
+        #   class Projects < ::API::Base
+        #   end
+        # end
+        MSG = 'Inherit from ::API::Base instead of Grape::API::Instance or Grape::API. ' \
+              'For more details check https://gitlab.com/gitlab-org/gitlab/-/issues/215230.'
 
+        def_node_matcher :grape_api, '(const (const {nil? (cbase)} :Grape) :API)'
         def_node_matcher :grape_api_definition, <<~PATTERN
           (class
             (const _ _)
-            (const
-              (const nil? :Grape) :API)
+            {#grape_api (const #grape_api :Instance)}
             ...
           )
         PATTERN
@@ -36,6 +41,12 @@ module RuboCop
             add_offense(node.children[1])
           end
         end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, '::API::Base')
+          end
+        end
       end
     end
   end

spec/rubocop/cop/api/base_spec.rb

+# frozen_string_literal: true
+
+require 'fast_spec_helper'
+require 'rubocop'
+require 'rubocop/rspec/support'
+require_relative '../../../../rubocop/cop/api/base'
+
+RSpec.describe RuboCop::Cop::API::Base, type: :rubocop do
+  include CopHelper
+
+  subject(:cop) { described_class.new }
+
+  let(:corrected) do
+    <<~CORRECTED
+      class SomeAPI < ::API::Base
+      end
+    CORRECTED
+  end
+
+  ['Grape::API', '::Grape::API', 'Grape::API::Instance', '::Grape::API::Instance'].each do |offense|
+    it "adds an offense when inheriting from #{offense}" do
+      expect_offense(<<~CODE)
+        class SomeAPI < #{offense}
+                        #{'^' * offense.length} #{described_class::MSG}
+        end
+      CODE
+
+      expect_correction(corrected)
+    end
+  end
+
+  it 'does not add an offense when inheriting from BaseAPI' do
+    expect_no_offenses(corrected)
+  end
+end

spec/rubocop/cop/api/grape_api_instance_spec.rb

-# frozen_string_literal: true
-
-require 'fast_spec_helper'
-require 'rubocop'
-require_relative '../../../../rubocop/cop/api/grape_api_instance'
-
-RSpec.describe RuboCop::Cop::API::GrapeAPIInstance do
-  include CopHelper
-
-  subject(:cop) { described_class.new }
-
-  it 'adds an offense when inheriting from Grape::API' do
-    inspect_source(<<~CODE)
-      class SomeAPI < Grape::API
-      end
-    CODE
-
-    expect(cop.offenses.size).to eq(1)
-  end
-
-  it 'does not add an offense when inheriting from Grape::API::Instance' do
-    inspect_source(<<~CODE)
-      class SomeAPI < Grape::API::Instance
-      end
-    CODE
-
-    expect(cop.offenses.size).to be_zero
-  end
-end