swagger-api / swagger-api/swagger-codegen

Unhelpful and suspect error "instance failed to match at least one required schema among 2"

Open
#4,317 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

The UI is simply displaying that error - google suggests that the payload carrying that error has significantly more detail, except the UI is not rendering any of it: there needs to be a way to see the entire error, not just this small description.

And, on the subject of the error itself: it suddenly started today, I don't think it's correct - all my backed-up YML produces the same error now, but none of them had errors when I backed them up last week.

... and on the subject of the error wording: that is a totally useless description. I have no idea whatsoever what it might mean, or what it's referring to, or why. This is a textbook example of "how never to write an error message". Please find what issued that error, and adjust it to include something useful that we can find/reference/understand!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Trace where the schema error is generated and where the UI renders it; done means exposing the full available error detail and replacing the vague message with information that identifies the cause and reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.