Refs #39464 - Add include_hosts param to avoid breaking public API

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: adamruzicka

app/controllers/api/v2/job_invocations_controller.rb

@@ -19,10 +19,17 @@ def index
 
       api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
+      param :include_hosts, :bool, :required => false, :default_value => true, :desc => N_('Include hosts and template invocations in the response. Defaults to true for backwards compatibility, pass false to skip serializing all hosts.')
+      param :host_status, :bool, :required => false, :default_value => false, :desc => N_('Show job status for each host, only applicable when include_hosts is true')
       def show
         @pattern_template_invocations = @job_invocation.pattern_template_invocations.includes(:input_values)
         @job_organization = Taxonomy.find_by(id: @job_invocation.task.input[:current_organization_id])
         @job_location = Taxonomy.find_by(id: @job_invocation.task.input[:current_location_id])
+
+        if params[:include_hosts].nil? || Foreman::Cast.to_bool(params[:include_hosts])
+          set_hosts_and_template_invocations
+          set_statuses_and_smart_proxies if Foreman::Cast.to_bool(params[:host_status])
+        end
       end
 
       def_param_group :job_invocation do
@@ -80,12 +87,14 @@ def show
 
       api :POST, '/job_invocations/', N_('Create a job invocation')
       param_group :job_invocation, :as => :create
+      param :include_hosts, :bool, :required => false, :default_value => true, :desc => N_('Include hosts and template invocations in the response. Defaults to true for backwards compatibility, pass false to skip serializing all hosts.')
       def create
         composer = JobInvocationComposer.from_api_params(
           job_invocation_params
         )
         composer.trigger!
         @job_invocation = composer.job_invocation
+        set_hosts_and_template_invocations if params[:include_hosts].nil? || Foreman::Cast.to_bool(params[:include_hosts])
         process_response @job_invocation
       rescue JobInvocationComposer::JobTemplateNotFound, JobInvocationComposer::FeatureNotFound => e
         not_found(error: { message: e.message })

app/views/api/v2/job_invocations/main.json.rabl

@@ -18,8 +18,32 @@ end
 child :targeting do
   attributes :bookmark_id, :bookmark_name, :search_query, :targeting_type, :user_id, :status, :status_label,
     :randomized_ordering
+
+  if @hosts
+    child @hosts => :hosts do
+      extends 'api/v2/hosts/base'
+
+      if @host_statuses
+        node :job_status do |host|
+          @host_statuses[host.id]
+        end
+      end
+    end
+  end
 end
 
 child :task do
   attributes :id, :state, :started_at
 end
+
+if @template_invocations
+  child @template_invocations => :template_invocations do
+    attributes :template_id, :template_name, :host_id
+    child :input_values do
+      attributes :template_input_name, :template_input_id
+      node :value do |iv|
+        iv.template_input.respond_to?(:hidden_value) && iv.template_input.hidden_value? ? '*' * 5 : iv.value
+      end
+    end
+  end
+end

test/functional/api/v2/job_invocations_controller_test.rb

@@ -36,6 +36,22 @@ class JobInvocationsControllerTest < ActionController::TestCase
           get :show, params: taxonomy_params.merge(:id => @invocation.id)
           assert_response :success
         end
+
+        test 'should include hosts by default' do
+          get :show, params: { :id => @invocation.id }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_not_nil result['targeting']['hosts']
+          assert_not_nil result['template_invocations']
+        end
+
+        test 'should exclude hosts when include_hosts=false' do
+          get :show, params: { :id => @invocation.id, :include_hosts => false }
+          assert_response :success
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_nil result['targeting']['hosts']
+          assert_nil result['template_invocations']
+        end
       end
 
       context 'creation' do
@@ -55,6 +71,20 @@ class JobInvocationsControllerTest < ActionController::TestCase
           assert_response :success
         end
 
+        test 'should include hosts in create response by default' do
+          post :create, params: { job_invocation: @attrs }
+          invocation = ActiveSupport::JSON.decode(@response.body)
+          assert_not_nil invocation['targeting']['hosts']
+          assert_response :success
+        end
+
+        test 'should exclude hosts from create response when include_hosts=false' do
+          post :create, params: { job_invocation: @attrs, include_hosts: false }
+          invocation = ActiveSupport::JSON.decode(@response.body)
+          assert_nil invocation['targeting']['hosts']
+          assert_response :success
+        end
+
         test 'should create with description format overridden' do
           @attrs[:description_format] = 'format'
           post :create, params: { job_invocation: @attrs }