OpenAPI block rendering is incomplete (especially examples)

[rocchisanijl]

Ask a question, start a conversation, or make an annoucement

the rendering of openapi is incomplete in particular for example put in the openapi file (see the screen shots comparing rendering gitbook versus swaggerhub)


swagger_e-financing_1.3.9.zip
https://docs.scalexpert.societegenerale.com/apidocs/3mLlrPx3sPtekcQvEEUg/api-reference/e-financing-api/uat-api-for-partners/v-1.3.9-e-financing-api-uat-for-partners-only

[addisonschultz]

Hey @rocchisanijl! Can you let us know more specifically what parts of the block aren't rendering as you'd expect?

[rocchisanijl]

the response of the endpoint /_simulate-solutions is not complete. As you can see in the screenshot from swagger hub.

[addisonschultz]

Thanks for pointing this out - I've logged it for the team to dive into!

[Vic-user]

Hello, @addisonschultz is there any progress on this topic? I'm encountering the same problem, where the example from my openapi.json file is not displayed in the response block of the layout.

[rocchisanijl]

Hi @Vic-user
it seems it has been improved but not yet as expected. In the meantime I had manually some code block for examples.

[Vic-user]

Hi @rocchisanijl , how did you manage to insert the response example in the layout? Or did you maybe do some changes to the source file? When I import an OpenAPI file, it will automatically generate the layout, but it seems to omit the example section from my json file.

[rocchisanijl]

Hi I just add some "code block" in the page below the open API block

[Vic-user]

@rocchisanijl Thanks for your input, I've followed your suggestion as a temporary solution. Hopefully we get something better down the road for such scenarios.

[Vic-user]

Hi team, do we have any progress on that? It will be really useful to have the actual examples come out-of-the-box when an OAS is imported.
@addisonschultz can you share a link to the opened issue for visibility?
Regards,
Victor

[addisonschultz]

Hi @Vic-user - unfortunately not a lot of movement on this currently. We do have it logged, and I see some chats that we’ll be investigating this with some other improvements to the overall OpenAPI block in a coming sprint - but I don’t have any timelines right now!