Editor <-> Preview Sync feature request

SteveS · June 11, 2025, 2:51pm

Hello @Anthony
Is it possible to have the Preview window vertical scroll position sync to the endpoint being worked on in the Editor?
For me, whenever the Preview window refreshes it goes to the top.

VSCode, Windows 10, v4.35.0

Anthony · June 12, 2025, 1:15am

Hi Steve,

There’s an existing feature request to sync the doc preview with the API spec. Checking to see if its feasible…
About seeing the preview window jump to the top on auto refresh, I checked on Windows and Mac with the same extension version and not seeing that behavior. When I make a change and the preview refreshes, it doesn’t go to the top.

I’ve searched the VSCode settings but didn’t find anything that causes the preview to autoscroll to the top. Possibly interference from another VSCode extension you’re using?

SteveS · June 12, 2025, 9:32am

Apologies @Anthony , I did a search but couldn’t see any feature request for it.

I’ve checked the ‘jump to top’ behaviour and I can reproduce it after a machine restart overnight.
The selected endpoint remains ‘open’ / selected, but I have to scroll back down the page to see it.

I don’t get the behaviour in the video, after an edit it jumps to the top of the page.

When I have time, I’ll disable some other extensions and provide an update.

Thanks

SteveS · June 17, 2025, 6:12am

Disabled all Extensions except RedHat YAML and OpenAPI (Swagger), restarted VSCode.
I still get the same behaviour.

Is there any output from the Preview that I can capture?

Anthony · June 17, 2025, 10:52am

Does it occur for every OAS file?
Try it with this sample file to check if the file contents are a factor:

github.com/swagger-api/swagger-petstore

src/main/resources/openapi.yaml

master

openapi: 3.0.4
info:
  title: Swagger Petstore - OpenAPI 3.0
  description: |-
    This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
    Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
    You can now help us improve the API whether it's by making changes to the definition itself or to the code.
    That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

    Some useful links:
    - [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
    - [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
  termsOfService: https://swagger.io/terms/
  contact:
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.27-SNAPSHOT
externalDocs:

This file has been truncated. show original

Toggle open the Developer Tools in VSCode, clear the console and then reproduce the issue. See if there are any issues reported in the console.

SteveS · June 27, 2025, 6:42am

Using that example yaml, it works fine. No jumps to the top.
I’ll see if I can reproduce with some generic yaml with no sensitive info in.