-
Notifications
You must be signed in to change notification settings - Fork 196
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
allOf not displayed correctly when part of an array type #349
Labels
bug
Something isn't working
Comments
Available for testing in |
I'd be also interested in that. I tested the I think both should be displayed. @sserrata would you mind taking a look? |
type: object
properties:
top_level_property:
type: array
items:
allOf:
- type: object
properties:
id:
description: System-generated unique ID of the Object
type: string
example: id12345
# readOnly: true
- type: object
properties:
description:
type: string
description: The description of the Identity Profile.
example: My custom flat file profile
nullable: true produces the following output: would you rather I report it in a new issue? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
If I have a spec defined with an array with items that are allOf under it, the generated documentation does not show the response correctly
Expected behavior
The response should show all of the objects defined in the schema.
Current behavior
Currently, the only thing that is displayed is the text "allOf" Example below:
Possible solution
Unsure at this time.
Steps to reproduce
Live example can be found here: https://developer.sailpoint.com/idn/api/v3/list-identity-profiles/
to reproduce this bug, you can create a schema with a response that has an array type with allOf in the items. An example response yaml:
Then generate the documentation and not that the all of is not presented properly.
Context
Our specification has a few instances of this scenario and they are not rendered properly on the page. I tried limiting the schema to just two objects and the error still persisted. I also switched it from allOf to oneOf and the oneOf was presented just fine, so it appears to be limited to just the allOf type.
Your Environment
"docusaurus-plugin-openapi-docs": "^1.4.5",
"@docusaurus/core": "^2.2.0",
The text was updated successfully, but these errors were encountered: