Reapply "CFE-4562: classfilterdata(): added docs for object of arrays/objects"

[larsewi]

This commit broke docs because it depends on
cfengine/core#5850. Once the dependency is
merged, it should be safe to reapply this commit.

This reverts commit 3bc6348.

Ticket: CFE-4562
Signed-off-by: Lars Erik Wik lars.erik.wik@northern.tech

[larsewi]

Please wait with merging this until dependency (cfengine/core#5850) is merged

[larsewi]

@cf-bottom Jenkins please :)

[cf-bottom]

Alright, I triggered a build:

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/174/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-174/output/_site/

[larsewi]

@cf-bottom Jenkins please :)

[cf-bottom]

Sure, I triggered a build:

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/175/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-175/output/_site/

[larsewi]

^ Looks like the arguments did not automatically update. Is this cached somehow? 🤔

[larsewi]

Ping @nickanderson

[nickanderson]

^ Looks like the arguments did not automatically update. Is this cached somehow? 🤔

I believe that comes from the syntax-description. So maybe the binary version generating the syntax didnt have your patch to evalfunction.c.

cf-promises --syntax-description=json | jq '.functions.classfilterdata'
{
  "cached": false,
  "category": "io",
  "collecting": true,
  "parameters": [
    {
      "description": "CFEngine variable identifier or inline JSON",
      "range": ".*",
      "type": "string"
    },
    {
      "description": "Specify type of data structure",
      "range": "array_of_arrays,array_of_objects,auto",
      "type": "option"
    },
    {
      "description": "Key or index of class expressions",
      "range": ".*",
      "type": "string"
    }
  ],
  "returnType": "data",
  "status": "normal",
  "variadic": false
}

[larsewi]

I believe that comes from the syntax-description. So maybe the binary version generating the syntax didnt have your patch to evalfunction.c.

Probably! At least it looks correct on the website now.