swagger-api / swagger-api/swagger.io-docs
Wrong indentation in 'Inheritance and Polymorphism' example
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
The example under the 'Model Composition' section is 'Inheritance and Polymorphism' has the wrong indentation on this page:
https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/
This can be confusing since there is no verbal explanation at what level 'allOf' should be included.
This is what we see:
This is what it should look like:
Hope this is of help!
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
Open the linked Inheritance and Polymorphism page and inspect the example under the Model Composition section. Compare its indentation with the expected screenshot, correct the example so the allOf level is clear, and verify the rendered documentation matches the requested layout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100