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.

Sign up for GitHub

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

Jump to bottom

OpenAPI Redocly "type" key does not display correctly #221

Open
mostaphaRoudsari opened this issue Nov 23, 2020 · 2 comments
Open

OpenAPI Redocly "type" key does not display correctly #221

mostaphaRoudsari opened this issue Nov 23, 2020 · 2 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@mostaphaRoudsari
Copy link
Member

I tried a number of different combinations and none of them really works:

  1. The schema that is generated from Pydantic is too large and redocly runs out of memory.
  2. The schema with inheritance generates the document but most of the object fields are considered recursive and don't show up correctly. This is probably because we now inherit all the classes from the same baseclass.

The better solution is to probably report the issue to redocly team.
@mostaphaRoudsari mostaphaRoudsari added bug Something isn't working documentation Improvements or additions to documentation labels Nov 23, 2020
mostaphaRoudsari added a commit to mostaphaRoudsari/honeybee-schema that referenced this issue Dec 9, 2020
@mostaphaRoudsari
ci(docs): fix docs deployment
2755428 
1. fix path to docs folder
2. added JSON Schema object for honeybee model. resolves ladybug-tools#182

I also tried to generate a new file without discriminator to fix the docs. It makes it slightly better but doesn't fix the issue. Related ladybug-tools#221
@mostaphaRoudsari mostaphaRoudsari mentioned this issue Dec 9, 2020
Merged
mostaphaRoudsari added a commit that referenced this issue Dec 9, 2020
@mostaphaRoudsari
ci(docs): fix docs deployment
9c278a6 
1. fix path to docs folder
2. added JSON Schema object for honeybee model. resolves #182

I also tried to generate a new file without discriminator to fix the docs. It makes it slightly better but doesn't fix the issue. Related #221
@chriswmackey
Copy link
Member

Looks like this issue was resolved but was not properly linked to the PR. I'm closing it now.

@mostaphaRoudsari
Copy link
Member Author

I would still consider this broken. I believe we have to report this to redocly team or just remove the type key for now which causes this issue.

image

@chriswmackey chriswmackey changed the title OpenAPI documentation for Model is broken OpenAPI Redocly "type" key does not display correctly Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mostaphaRoudsari @chriswmackey