[FEAT] Please document that selector are using JSONata

Is your feature request related to a problem? Please describe. I’m using a kv2 store, with a key that had a dash: foo-bar. This produced errors that we difficult to resolve: Unable to retrieve result for data.data.foo-bar. No match data was found. Double check your Key or Selector.

Upon reading the source code, I found references to JSONata; reading their docs, I found that I could escape things with backquotes, and this resolved the issue.

Describe the solution you’d like Please add in the relevant section in the README that the selector syntax is using JSONata.

Describe alternatives you’ve considered I guess ripping the library out and doing something home-grown is fine too? But that seems like a lot of work, and the actual problem is just documenting it (which would have to be done either way).

Additional context

uses: hashicorp/vault-action@v2.0.1

[doowb]

In case this is helpful to anyone else that needs to retrieve the entire JSON object from the secret, you can use $.$ as the selector:

secrets: secret/path/to/my-secret $.$ | MY_SECRET;

Just using $ or * might have worked with jsonata, but the selector is quoted here when it doesn’t contain a .. It would be nice to be able to just do . or * to get the entire object, but I think that would be a separate feature request and I’m not sure where it would fit.

[benkeil]

after one year, any progress here? how could such a basic feature not be included from the first day?