Merge branch 'bvl-api-feature-categories-2' into 'master'

Add feature categories to the API B -> G

See merge request gitlab-org/gitlab!46421

lib/api/badges.rb

@@ -8,6 +8,8 @@ module API
 
     helpers ::API::Helpers::BadgesHelpers
 
+    feature_category :continuous_integration
+
     helpers do
       def find_source_if_admin(source_type)
         source = find_source(source_type, params[:id])

lib/api/boards.rb

@@ -9,6 +9,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :boards
+
     helpers do
       def board_parent
         user_project

lib/api/branches.rb

@@ -10,6 +10,8 @@ module API
 
     after_validation { content_type "application/json" }
 
+    feature_category :source_code_management
+
     before do
       require_repository_enabled!
       authorize! :download_code, user_project

lib/api/broadcast_messages.rb

@@ -4,6 +4,8 @@ module API
   class BroadcastMessages < ::API::Base
     include PaginationParams
 
+    feature_category :navigation
+
     resource :broadcast_messages do
       helpers do
         def find_message

lib/api/ci/pipeline_schedules.rb

@@ -7,6 +7,8 @@ module API
 
       before { authenticate! }
 
+      feature_category :continuous_integration
+
       params do
         requires :id, type: String, desc: 'The ID of a project'
       end

lib/api/ci/pipelines.rb

@@ -7,6 +7,8 @@ module API
 
       before { authenticate_non_get! }
 
+      feature_category :continuous_integration
+
       params do
         requires :id, type: String, desc: 'The project ID'
       end

lib/api/ci/runner.rb

@@ -7,6 +7,8 @@ module API
 
       content_type :txt, 'text/plain'
 
+      feature_category :continuous_integration
+
       resource :runners do
         desc 'Registers a new Runner' do
           success Entities::RunnerRegistrationDetails

lib/api/ci/runners.rb

@@ -7,6 +7,8 @@ module API
 
       before { authenticate! }
 
+      feature_category :continuous_integration
+
       resource :runners do
         desc 'Get runners available for user' do
           success Entities::Runner

lib/api/commit_statuses.rb

@@ -4,6 +4,8 @@ require 'mime/types'
 
 module API
   class CommitStatuses < ::API::Base
+    feature_category :continuous_integration
+
     params do
       requires :id, type: String, desc: 'The ID of a project'
     end

lib/api/commits.rb

@@ -6,6 +6,8 @@ module API
   class Commits < ::API::Base
     include PaginationParams
 
+    feature_category :source_code_management
+
     before do
       require_repository_enabled!
       authorize! :download_code, user_project

lib/api/container_registry_event.rb

@@ -4,6 +4,8 @@ module API
   class ContainerRegistryEvent < ::API::Base
     DOCKER_DISTRIBUTION_EVENTS_V1_JSON = 'application/vnd.docker.distribution.events.v1+json'
 
+    feature_category :package_registry
+
     before { authenticate_registry_notification! }
 
     resource :container_registry_event do

lib/api/deploy_keys.rb

@@ -6,6 +6,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :continuous_delivery
+
     helpers do
       def add_deploy_keys_project(project, attrs = {})
         project.deploy_keys_projects.create(attrs)

lib/api/deploy_tokens.rb

@@ -4,6 +4,8 @@ module API
   class DeployTokens < ::API::Base
     include PaginationParams
 
+    feature_category :continuous_delivery
+
     helpers do
       def scope_params
         scopes = params.delete(:scopes)

lib/api/deployments.rb

@@ -7,6 +7,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :continuous_delivery
+
     params do
       requires :id, type: String, desc: 'The project ID'
     end

lib/api/environments.rb

@@ -7,6 +7,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :continuous_delivery
+
     params do
       requires :id, type: String, desc: 'The project ID'
     end

lib/api/error_tracking.rb

@@ -4,6 +4,8 @@ module API
   class ErrorTracking < ::API::Base
     before { authenticate! }
 
+    feature_category :error_tracking
+
     params do
       requires :id, type: String, desc: 'The ID of a project'
     end

lib/api/events.rb

@@ -8,6 +8,8 @@ module API
 
     allow_access_with_scope :read_user, if: -> (request) { request.get? }
 
+    feature_category :users
+
     resource :events do
       desc "List currently authenticated user's events" do
         detail 'This feature was introduced in GitLab 9.3.'

lib/api/feature_flag_scopes.rb

@@ -7,6 +7,8 @@ module API
     ENVIRONMENT_SCOPE_ENDPOINT_REQUIREMENTS = FeatureFlags::FEATURE_FLAG_ENDPOINT_REQUIREMENTS
       .merge(environment_scope: API::NO_SLASH_URL_PART_REGEX)
 
+    feature_category :feature_flags
+
     before do
       authorize_read_feature_flags!
     end

lib/api/feature_flags.rb

@@ -7,6 +7,8 @@ module API
     FEATURE_FLAG_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS
         .merge(name: API::NO_SLASH_URL_PART_REGEX)
 
+    feature_category :feature_flags
+
     before do
       authorize_read_feature_flags!
     end

lib/api/feature_flags_user_lists.rb

@@ -8,6 +8,8 @@ module API
       message.is_a?(String) ? { message: message }.to_json : message.to_json
     }
 
+    feature_category :feature_flags
+
     before do
       authorize_admin_feature_flags_user_lists!
     end

lib/api/features.rb

@@ -4,6 +4,8 @@ module API
   class Features < ::API::Base
     before { authenticated_as_admin! }
 
+    feature_category :feature_flags
+
     helpers do
       def gate_value(params)
         case params[:value]

lib/api/files.rb

@@ -9,6 +9,8 @@ module API
     # Prevents returning plain/text responses for files with .txt extension
     after_validation { content_type "application/json" }
 
+    feature_category :source_code_management
+
     helpers ::API::Helpers::HeadersHelpers
 
     helpers do

lib/api/freeze_periods.rb

@@ -6,6 +6,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :continuous_delivery
+
     params do
       requires :id, type: String, desc: 'The ID of a project'
     end

lib/api/group_boards.rb

@@ -7,6 +7,8 @@ module API
 
     prepend_if_ee('EE::API::BoardsResponses') # rubocop: disable Cop/InjectEnterpriseEditionModule
 
+    feature_category :boards
+
     before do
       authenticate!
     end

lib/api/group_clusters.rb

@@ -6,6 +6,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :kubernetes_management
+
     params do
       requires :id, type: String, desc: 'The ID of the group'
     end

lib/api/group_container_repositories.rb

@@ -8,6 +8,8 @@ module API
 
     before { authorize_read_group_container_images! }
 
+    feature_category :package_registry
+
     REPOSITORY_ENDPOINT_REQUIREMENTS = API::NAMESPACE_OR_PROJECT_REQUIREMENTS.merge(
       tag_name: API::NO_SLASH_URL_PART_REGEX)
 

lib/api/group_export.rb

@@ -10,6 +10,8 @@ module API
       authorize! :admin_group, user_group
     end
 
+    feature_category :importers
+
     params do
       requires :id, type: String, desc: 'The ID of a group'
     end

lib/api/group_import.rb

@@ -2,6 +2,8 @@
 
 module API
   class GroupImport < ::API::Base
+    feature_category :importers
+
     helpers Helpers::FileUploadHelpers
 
     helpers do

lib/api/group_labels.rb

@@ -7,6 +7,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :issue_tracking
+
     params do
       requires :id, type: String, desc: 'The ID of a group'
     end

lib/api/group_milestones.rb

@@ -7,6 +7,8 @@ module API
 
     before { authenticate! }
 
+    feature_category :issue_tracking
+
     params do
       requires :id, type: String, desc: 'The ID of a group'
     end

lib/api/group_variables.rb

@@ -7,6 +7,8 @@ module API
     before { authenticate! }
     before { authorize! :admin_build, user_group }
 
+    feature_category :continuous_integration
+
     params do
       requires :id, type: String, desc: 'The ID of a group'
     end

lib/api/groups.rb

@@ -7,6 +7,8 @@ module API
 
     before { authenticate_non_get! }
 
+    feature_category :subgroups
+
     helpers Helpers::GroupsHelpers
 
     helpers do

spec/lib/api/every_api_endpoint_spec.rb

@@ -22,7 +22,17 @@ RSpec.describe 'Every API endpoint' do
         completed_classes = [
           ::API::Users, ::API::Issues, ::API::AccessRequests, ::API::Admin::Ci::Variables,
           ::API::Admin::InstanceClusters, ::API::Admin::Sidekiq, ::API::Appearance,
-          ::API::Applications, ::API::Avatar, ::API::AwardEmoji
+          ::API::Applications, ::API::Avatar, ::API::AwardEmoji, API::Badges,
+          ::API::Boards, ::API::Branches, ::API::BroadcastMessages, ::API::Ci::Pipelines,
+          ::API::Ci::PipelineSchedules, ::API::Ci::Runners, ::API::Ci::Runner,
+          ::API::Commits, ::API::CommitStatuses, ::API::ContainerRegistryEvent,
+          ::API::DeployKeys, ::API::DeployTokens, ::API::Deployments, ::API::Environments,
+          ::API::ErrorTracking, ::API::Events, ::API::FeatureFlags, ::API::FeatureFlagScopes,
+          ::API::FeatureFlagsUserLists, ::API::Features, ::API::Files, ::API::FreezePeriods,
+          ::API::GroupBoards, ::API::GroupClusters, ::API::GroupExport, ::API::GroupImport,
+          ::API::GroupLabels, ::API::GroupMilestones, ::API::Groups,
+          ::API::GroupContainerRepositories, ::API::GroupVariables
+
         ]
         next unless completed_classes.include?(klass)