question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

OpenAPI 3.0 Callback malformed rendering

See original GitHub issue

Describe the bug OpenAPI 3.0 callback fields do not get rendered correctly in the .md output. There are a few issues:

  • I think the main issue is that the ## heading is duplicated for each request, even if there’s only one request with a callback. This may be triggering the secondary issues. Please see the attached screenshot of Shins loading the .md file.
  • The API call is duplicated in the center column.
  • The code block is rendered within the center column.
  • - I have checked that my input document is valid OpenAPI 2.0/3.0.x or AsyncAPI 1.x

To Reproduce Steps to reproduce the behavior:

  1. For the input file, use the callback-example.md from the official OpenAPI repo’s 3.0 example spec: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/callback-example.yaml
  2. Command-line:
node widdershins callback-example.yaml -o callback-example.md
  1. Load callback-example.md from shins.
  2. See layout errors in screenshot.

Expected behavior I’d expect:

  • To see a single entry in the TOC for post__streams.
  • To see a single entry in the enter column for post_stream.
  • To not see example code in the center column.

Screenshots screen shot 2018-10-19 at 5 04 10 pm

Versions:

Issue Analytics

  • State:open
  • Created 5 years ago
  • Comments:6 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
MikeRalphsoncommented, Oct 23, 2018

Thanks for digging further. I believe it was working when released, possibly the overrides css in shins is required.

0reactions
galvocommented, Jan 27, 2020

Any update on this? also happy to test it out

Read more comments on GitHub >

github_iconTop Results From Across the Web

OpenAPI Specification - Version 3.0.3 - Swagger
The OpenAPI Specification defines a standard interface to RESTful APIs which allows both humans and computers to understand service capabilities without ...
Read more >
OpenAPI Specification v3.0.3 | Introduction, Definitions, & More
Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the...
Read more >
Issue in rendering Swagger OpenAPI v3 UI + Springboot project
The problem is localhost:8080/v3/api-docs/ responses "{"openapi":"3.0.1", "\info":{..." which is a String, NOT a valid JSON as expected. It ...
Read more >
TS 129 501 - V17.6.0 - 5G ; 5G System; Principles and Guidelines ...
OpenAPI : "OpenAPI Specification Version 3.0.0", ... A complete callback URI for the "smContextStatusUri" has the following structure.
Read more >
ForgeRock Access Management 6.5 > Development Guide
Serves an API descriptor that complies with the OpenAPI specification. ... The /json/authenticate endpoint supports callback mechanisms to perform complex ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found