alphagov / alphagov/tech-docs-gem
API documentation issues
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
What should change
After following the guide to generate API documentation from an OpenAPI spec, we've found that Array/List responses are rendered incorrectly - they appear as empty objects.
The response should appear as a a list of objects as they do in Swagger, for example: https://create-and-vary-a-licence-and-delius-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html#/probation-case-resource/findAddresses
Contributor guide
No contributing guide indexed for this repository
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 with the OpenAPI documentation generation guide and reproduce the linked probation-case example, where an array response is rendered as an empty object. Compare the generated page with the linked Swagger response; done means list responses display their objects correctly in the API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100