Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation issues #334

Open
marcus-bcl opened this issue Oct 3, 2023 · 1 comment
Open

API documentation issues #334

marcus-bcl opened this issue Oct 3, 2023 · 1 comment

Comments

@marcus-bcl
Copy link

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.

For example, see: https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/create-and-vary-a-licence-and-delius/api-reference.html#probation-case-crn-addresses
image

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
image

@anahickmann
Copy link

anahickmann commented Mar 27, 2024

I've had a similar problem with list of strings getting displayed as a list with one empty object.

This is how the response is getting displayed (i.e. an array with one empty object):
Screenshot 2024-03-27 at 10 27 38

And this is how it should get displayed (i.e. an array with one string):
Screenshot 2024-03-27 at 10 27 55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants