Fix apidoc

theforeman · May 21, 2021 · 26c0e3a · 26c0e3a
1 parent 7cecc1b
commit 26c0e3a
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 14 deletions.
diff --git a/app/controllers/foreman_puppet/api/v2/base_controller.rb b/app/controllers/foreman_puppet/api/v2/base_controller.rb
@@ -3,7 +3,8 @@ module Api
     module V2
       class BaseController < ::Api::V2::BaseController
         resource_description do
-          api_version '2'
+          resource_id 'foreman_puppet_base'
+          api_version 'v2'
           api_base_url '/foreman_puppet/api'
         end
 

diff --git a/app/controllers/foreman_puppet/api/v2/config_groups_controller.rb b/app/controllers/foreman_puppet/api/v2/config_groups_controller.rb
@@ -1,9 +1,13 @@
 module ForemanPuppet
   module Api
     module V2
-      class ConfigGroupsController < BaseController
+      class ConfigGroupsController < ::ForemanPuppet::Api::V2::BaseController
         include ForemanPuppet::Parameters::ConfigGroup
 
+        resource_description do
+          resource_id 'pp_config_group'
+        end
+
         wrap_parameters ConfigGroup, include: config_group_params_filter.accessible_attributes(parameter_filter_context)
 
         before_action :find_resource, only: %i[show update destroy]

diff --git a/app/controllers/foreman_puppet/api/v2/environments_controller.rb b/app/controllers/foreman_puppet/api/v2/environments_controller.rb
@@ -1,13 +1,12 @@
 module ForemanPuppet
   module Api
     module V2
-      class EnvironmentsController < BaseController
+      class EnvironmentsController < ::ForemanPuppet::Api::V2::BaseController
         include ForemanPuppet::Api::ImportPuppetclassesCommonController
         include ForemanPuppet::Parameters::Environment
 
         resource_description do
-          api_version '2'
-          api_base_url '/foreman_puppet/api'
+          resource_id 'pp_environments'
         end
 
         before_action :find_optional_nested_object

diff --git a/app/controllers/foreman_puppet/api/v2/host_classes_controller.rb b/app/controllers/foreman_puppet/api/v2/host_classes_controller.rb
@@ -1,7 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class HostClassesController < V2::BaseController
+      class HostClassesController < ::ForemanPuppet::Api::V2::BaseController
+        resource_description do
+          resource_id 'pp_host_classes'
+        end
+
         before_action :find_host, only: %i[index create destroy]
         before_action :find_puppetclass, only: %i[create destroy]
 

diff --git a/app/controllers/foreman_puppet/api/v2/hostgroup_classes_controller.rb b/app/controllers/foreman_puppet/api/v2/hostgroup_classes_controller.rb
@@ -1,7 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class HostgroupClassesController < V2::BaseController
+      class HostgroupClassesController < ::ForemanPuppet::Api::V2::BaseController
+        resource_description do
+          resource_id 'pp_host_group_classes'
+        end
+
         before_action :find_hostgroup, only: %i[index create destroy]
 
         api :GET, '/hostgroups/:hostgroup_id/puppetclass_ids/', N_('List all Puppet class IDs for host group')

diff --git a/app/controllers/foreman_puppet/api/v2/lookups_common_controller.rb b/app/controllers/foreman_puppet/api/v2/lookups_common_controller.rb
@@ -2,6 +2,12 @@ module ForemanPuppet
   module Api
     module V2
       class LookupsCommonController < ::Api::V2::BaseController
+        resource_description do
+          resource_id 'foreman_puppet_lookups_common'
+          api_version 'v2'
+          api_base_url '/foreman_puppet/api'
+        end
+
         before_action :find_environment, if: :environment_id?
         before_action :find_puppetclass, if: :puppetclass_id?
         before_action :find_host, if: :host_id?

diff --git a/app/controllers/foreman_puppet/api/v2/override_values_controller.rb b/app/controllers/foreman_puppet/api/v2/override_values_controller.rb
@@ -1,12 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class OverrideValuesController < LookupsCommonController
+      class OverrideValuesController < ::ForemanPuppet::Api::V2::LookupsCommonController
         include Foreman::Controller::Parameters::LookupValue
 
         resource_description do
-          api_version '2'
-          api_base_url '/foreman_puppet/api'
+          resource_id 'pp_override_values'
         end
 
         before_action :find_override_values

diff --git a/app/controllers/foreman_puppet/api/v2/puppetclasses_controller.rb b/app/controllers/foreman_puppet/api/v2/puppetclasses_controller.rb
@@ -1,9 +1,13 @@
 module ForemanPuppet
   module Api
     module V2
-      class PuppetclassesController < BaseController
+      class PuppetclassesController < ::ForemanPuppet::Api::V2::BaseController
         include ForemanPuppet::Parameters::Puppetclass
 
+        resource_description do
+          resource_id 'pp_puppetclasses'
+        end
+
         before_action :find_optional_nested_object
         before_action :find_resource, only: %w[show update destroy]
 

diff --git a/app/controllers/foreman_puppet/api/v2/smart_class_parameters_controller.rb b/app/controllers/foreman_puppet/api/v2/smart_class_parameters_controller.rb
@@ -1,12 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class SmartClassParametersController < ForemanPuppet::Api::V2::LookupsCommonController
+      class SmartClassParametersController < ::ForemanPuppet::Api::V2::LookupsCommonController
         include ForemanPuppet::Parameters::PuppetclassLookupKey
 
         resource_description do
-          api_version '2'
-          api_base_url '/foreman_puppet/api'
+          resource_id 'pp_smart_class_parameters'
         end
 
         alias_method :resource_scope, :smart_class_parameters_resource_scope