combined schema (anyOf, allOf, oneOf) error message enhancement
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by reproducing the reported orquesta task transition with publish set to a dict instead of an array, then trace the schema validation error where the schema path ends in oneOf. Done means the error explains the accepted string or array-of-dicts alternatives for this invalid value.
Written by the indexing model from the issue text.
Description
I think this goes here, but if it goes on StackStorm/st2, I can file the issue there.
This issue is about improving the error message returned when a schema validation error occurs due to not matching a oneOf schema.
I ran an orquesta workflow and for the task transition I used the incorrect:
publish:
message: foobar
instead of the correct:
publish:
- message: foobar
Doing that gave me an error message like:
{
"spec_path": "tasks.validate_input.next[0].publish",
"message": "{'error_message': 'wrong format for input param foobar: {{ ctx().foobar }}'} is not valid under any of the given schemas",
"type": "syntax",
"schema_path": "properties.tasks.patternProperties.^\\w+$.properties.next.items.properties.publish.oneOf"
},
Then, I went to look up the schema to figure out what I did wrong, mistakenly guessing that it didn't like my use of Jinja. My error was passing in a dict instead of an array. Could the error message be improved to say what the options are when the schemaPath is oneOf? (in this case string or array of unique one item dicts)
- Dominant language
- Python
- Stars
- 111
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from StackStorm/orquesta
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
StackStorm/orquesta#275 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
StackStorm/orquesta#274 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
StackStorm/orquesta#272 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
StackStorm/orquesta#268 ·
-
Vague errorOpen
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
StackStorm/orquesta#265 · 1 comment ·
All issues in StackStorm/orquesta
Similar issues
-
bug needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
debpalash/VoiceStudio#2624 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Make Catch2 optional when `RDK_BUILD_CPP_TESTS=OFF`Possibly taken @pechersky claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 2 days
-
There are a few redundant calls to `fdesc._setCloseOnExec()`Possibly taken @gudnimg claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day