This website uses Cookies. Click Accept to agree to our website's cookie use as described in our Privacy Policy. Click Preferences to customize your cookie settings.
Accept
Reject
Preferences
Log in to ask a question
Log in to ask a question

Integrated Developer Portal current OAS support does not render examples correctly

Posted on 09-13-2023 07:10 AM
bmcd77
Bronze 4
Bronze 4
Reply posted on --/--/---- --:-- AM

Hi Guys,

We are hitting issues with some of our Open API Specs (versions 3.0.0, 3.0.1, 3.0.2) which render and work fine on SwaggerEditor. Particularly the examples section of the Open API Spec is 'destroying' our (yes legacy) SOAP examples. It does not seem to respect yaml multiline formatting (like YAML Multiline Strings (yaml-multiline.info)

As open API Spec that looks like this on swagger :

bmcd77_1-1694613373918.png

Ends up looking like this in the OAS examples section of the Integrated portal:
(which makes it an invalid SOAP request and it cannot be copied to the try it function directly without a fair bit of fixing. Not very friendly!)

bmcd77_3-1694613607002.png

As a workaround we are writing our sandbox examples in markup at the top of the OAS but it's a hack 

bmcd77_2-1694613575103.png

Can you please up the supported version of the OpenAPI Spec on the Integrated Developer Portal to OpenAPI 3.0.x? (I'm guessing that would be the issue here). Thanks.



 

0 1 135
Topic Labels
0 Likes
1 REPLY 1

Posted on --/--/---- --:-- AM
bmcd77
Bronze 4
Bronze 4
Reply posted on --/--/---- --:-- AM

Still having this issue. Would be super helpful if OAS 3.0 could be supported in smart docs for the Integrated Portal? Our team is currently  performing gymnastics unnecessarily as a result.