API v4 explorer: boolean params don't render correctly for CV (short)

The API4 explorer generates shorthand cv syntax that looks like, for example:

cv api4 Contact.delete +w 'id = 99' checkPermissions=false useTrash=false

However, cv does not correctly interpret false in this context. The syntax that works is:

cv api4 Contact.delete +w 'id = 99' checkPermissions=0 useTrash=0

So the explorer should generate that syntax.

added comp:APIv4 label

Whether this is a cv issue or an API4 explorer issue is debatable, but cv api4 --help shows an example of 1 standing in for true, so I created PR #25589 to make the explorer conform to this syntax.

added has-pull-request label

added triaged label

Hi,

Thank you for raising an issue to help improve CiviCRM. As you may know, this issue has not had any activity for quite some time, so we have closed it.

We would like you to help us to determine if this issue should be re-opened:

• If this issue was reporting a bug, can you attempt to reproduce it on a latest version of CiviCRM?
• If this issue was proposing a new feature, can you verify if the feature proposal is still relevant? Did it get the concept-approved label? Have other people also shown interest? Could it be implemented as an extension?

If the answer to either question is yes, please feel free to comment or re-open the issue. Please also consider:

• Is it something that you could help implement, either by sending a patch or hiring someone who can?
• Would you be willing to fund the work, either through a CiviCRM partner, or the Core Team?

Thank you for your help and contributions to CiviCRM.

P.S. This is an automated message, see infra/gitlab issue 20. We understand that automatic responses are annoying, but given the number of open issues as the project evolves, we need a bit of help to triage and prioritise the most relevant issues.

closed

PR was merged so this is fixed.

This issue appears still to be present in 5.78.3, e.g. it generated this:
cv api4 Relationship.update +v is_active=true +w 'relationship_type_id = 5' +w 'is_active = true'

I found that when run with cv, this command targets inactive relationships rather than active. Luckily the value parameter gets similarly misconstrued, so it is at least consistent.

(If you're wondering why anyone would want a command to update active relationships to active, it's a no-op update to trigger inherited memberships to update, where they had failed to inherit.)

Can you try is_active=1 instead?

Hi @colemanw , yes changing true to 1 in the generated command works, the bug is that the APIv4 explorer generates cv code that doesn't work correctly.

@davej try this: https://github.com/civicrm/civicrm-core/pull/31393

A pull request related to this issue has been opened with the title: #4129 (closed) Api4Explorer - Render true/false as 1/0 in cli code

mentioned in commit 41401f9e