swagger-api / swagger-api/validator-badge
attribute definitions.Dummy.externalDocs is unexpected
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 227
- Forks
- 81
- Avg merge
- 2h 3m
- Merged PRs (30d)
- 1
Description
The online validator is throwing an error on the attribute externalDocs on an entity definition, although it is explicitly allowed by the spec: http://swagger.io/specification/#schemaObject
I have an online example to show that issue: http://www.bit9.ch/apiplatform.json
http://online.swagger.io/validator/debug?url=http://www.bit9.ch/apiplatform.json
{
"messages": [
"attribute definitions.Dummy.externalDocs is unexpected",
"attribute definitions.Dummy_be35824b9d92d1dfc6f78fe086649b8f.externalDocs is unexpected"
]
}
I also tested it with the release 1.0.4 locally, having the same result.
Contributor guide
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.
Research direction
Start by running the online validator against the linked apiplatform.json example and compare its handling with the Swagger Schema Object specification. Inspect the validator path used by release 1.0.4 and reproduce the unexpected externalDocs messages; done means valid entity definitions no longer report externalDocs as unexpected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100