swagger-api / swagger-api/swagger-ui
XML examples are incorrectly formatted.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
The example value starts with:
It should begin with:
<a:feed xmlns:a="http://www.w3.org/2005/Atom" xmlns:m="http://docs.oasis-open.org/odata/ns/metadata" xmlns:d="http://docs.oasis-open.org/odata/ns/data" m:context="$metadata#MyAddresses">
Additional information to reproduce the issue, e.g. server, browser version, operating system, ...
This may be related this FastAPI issue, which appears to be used in Swagger/OpenAPI: https://github.com/tiangolo/fastapi/discussions/8440
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
Reproduce the XML example in Swagger UI and compare it with the expected declaration and namespaces in the issue. Trace the Swagger/OpenAPI example-generation or display entry point, and consult the linked FastAPI discussion for context; done means the example begins with the XML declaration and expected feed element, with a regression check for the corrected output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100