How to filter results in Chef Search API

Question

Chef Node API, like /nodes/nodename will return the full node object like:

{
  "name": "node_name",
  "chef_environment": "_default",
  "run_list": [
    "recipe[recipe_name]"
  ]
  "json_class": "Chef::Node",
  "chef_type": "node",
  "automatic": { ... },
  "normal": { "tags": [ ] },
  "default": { },
  "override": { "cookbook1_name"=>{
                    "attribute1"=>"overridevalue"
              }}
}

I am trying to use Chef::Search::Query.search REST API to just return a few required columns instead of full node object. For example:

Chef::Search::Query.new("server url").search(:node, '*:*', :filter_result => {'name' => ['name'] } )

It works that will return the node name only, but when I try to add the override data, it always return null...

Chef::Search::Query.new("server url").search(:node, '*:*', :filter_result => {'name' => ['name'], 'override' => ['override'] } )

It seems that the filter_result can work for type like string, or array, but override is a json object, how to include it in result?

Thanks!

Answer 1

et The key path in filter_result is run against the merged attribute form. You would want something like 'attribute1' => ['cookbook1_name', 'attribute1'].

EDIT:

For a direct example:

$ knife node show foo -z -l -Fj
{
  "name": "foo",
  "chef_environment": "_default",
  "run_list": [

]
,
  "normal": {

  },
  "default": {

  },
  "override": {
    "key1": {
      "key2": "value"
    }
  },
  "automatic": {

  }
}
$ knife exec -z -E 'puts search(:node, "*:*").inspect'
[#<Chef::Node:0x007f89e3ee97f0 @chef_server_rest=nil, @name="foo", @chef_environment="_default", @primary_runlist=#<Chef::RunList:0x007f89e3ee9728 @run_list_items=[]>, @override_runlist=#<Chef::RunList:0x007f89e3ee9660 @run_list_items=[]>, @policy_name=nil, @policy_group=nil, @attributes=#<Chef::Node::Attribute @default={}, @env_default={}, @role_default={}, @force_default={}, @normal={}, @override={"key1"=>{"key2"=>"value"}}, @role_override={}, @env_override={}, @force_override={}, @automatic={}, @merged_attributes=nil, @properties=nil>, @run_state={}>]
$ knife exec -z -E 'puts search(:node, "*:*", filter_result: {myval: %w{key1 key2}}).inspect'
[{"myval"=>"value"}]