smartbear / vscode-swaggerhub-release

SwaggerHub for VS Code - Providing SwaggerHub Integration inside the Visual Studio Code IDE.

SwaggerHub for VS Code: Issue Tracker

SwaggerHub extension for VS Code lets you view and edit OpenAPI definitions stored in SwaggerHub directly from VS Code.

In this repository, you can:

❔ Ask questions about the extension
🐛 Report bugs
💡 Suggest new features or enhancements
👍 Upvote existing requests
📝 Submit general feedback

Please search existing issues before opening a new one.

Resources

• SwaggerHub documentation: Learn more about SwaggerHub
• OpenAPI syntax guide: Learn how to write OpenAPI definitions

If you need help with SwaggerHub itself (not the VS Code extension), contact Support.

vscode-swaggerhub-release's Issues

Intellisense / auto-complete support

Does this extension support Intellisense / auto-complete like SwaggerHub web UI?

SwaggerHub UI is reading new API versions (OAS 3.0.0) created with VS plugin as swagger 2.0

I have created new versions of API's definitions (OAS 3.0.0) using the Swaggerhub VS plugin and the new versions are created successfully but when I try to access the new version in SwaggerHub, it asks me to convert it to OAS 3.0.0 or remain at Swagger 2.0. I can see that the definition is OAS 3.0.0 but it appears to be reading it as Swagger 2.0.

On-Premise certificate error

I'am getting following error when I refresh apis and domains. Because of that error list is not filled.

Error:

request to (url) failed, reason: unable to verify the first certificate

Response headers for Try it Out differ on VS Code to the SH web app

I was using the Try it out in conjunction with a POST endpoint that returns a location header with a 201 and noticed that the SwaggerUI in the VSCode extension shows different results to what is shown on the web app (Crucially the header I have added is missing)

Saving new version of a published API?

I have a published API that had a version attribute of '1'. When I went to save a new version of the API (v '1.0.1') it gave an error saying that I couldn't save changes to a published API.

When I "unpublished" the v1 API, then I could save the 1.0.1 version and it saved a new version of the API, and then I had to go back and re-publish the original v1 version.

Is this the intended functionality / workflow here? I expected that me saving 1.0.1 from a published version would have created a new unpublished version and left the published one alone.

VS Code Workspace support

As a developer it would be useful to be able to associate the AOS spec for an API with the implementation code within a Visual Studio Code workspace.

Couldn't connect to the app.swaggerhub.com from VS code SwaggerHub extension

The following error showing:

invalid json response body at https://app.swaggerhub.com/apis/xxxxxxxx?page=0&limit=100&sort=NAME&order=ASC reason: Unexpected token < in JSON at position 0

How to access SwaggerHub on-premise instance secured via Azure AD SSO

Updated:
Whenever you secure your SwaggerHub (on premise) setup behind a secured Proxy, like Azure Application Proxy with a security profile for oAuth, the plugin will fail to authenticate as it does not handle oauth (or other flows) before hitting swaggerhub. The only way to use this plugin now is if your SwaggerHub on premise is accessible via direct network connection or public dns without security proxy from the machine running vscode.

This is the error I get currently:
https://login.microsoftonline.com/4cbfea0a-b872-47f0-b51c-1c64953c3f0b/oauth2/authorize?response_type=code&client_id=c6826fdb-1957-40ba-9d94-4b58edbc7cc6&scope=openid&nonce=b3c4b720-baa3-4b96-bb64-309b86f8ab03&redirect_uri=https%3a%2f%2fswaggerhub.tech.dnb.no%2f&state=AppProxyState%3a%7b%22InvalidTokenRetry%22%3atrue%2c%22IsMsofba%22%3afalse%2c%22OriginalRawUrl%22%3a%22https%3a%5c%2f%5c%2fswaggerhub.tech.dnb.no%5c%2fapis%5c%2fDomainAPIs%3fpage%3d0%26limit%3d100%26sort%3dNAME%26order%3dASC%22%2c%22RequestProfileId%22%3a%22eb9ae144-3864-4621-a3a2-a333d5798e13%22%7d%23EndOfStateParam%23&client-request-id=b3c438de-8cbd-46b1-9fb0-b9e830d5e919 reason: Unexpected token < in JSON at position 4

YAML vs JSON

The SwaggerHub for VS Code implementation looks good for APIs dveloped and defined in YAML. - I'm missing the same options/features and functionality (e.g. syntax high lighting, SwaggerHub context menu, ...) for the APIs developed and defined in JSON.

Are there any plans on providing the same features for the JSON defined APIs as well?

Andreas

Is there a way to manage change conflicts (multi-user editing)?

If we have multiple team members updating an API at the same time, is there a way to merge the changes?

If I edit an API through the VS Code extension and another team member is editing the same API through app.swaggerhub.com,
they receive a notification that someone else has edited the API.

If someone edits an API through app.swaggerhub.com and I'm editing the same API through the extension, I don't get any
indication that the API has changed. If I save my changes, I can undo the changes of other team members without realising.

When the API spec is saved in VS Code, it appears to be updated in app.swaggerhub.com immediately without any warnings.

It would be ideal is some kind of change conflict management could be included

Sync with local copy

I would love an option to write to both swaggerhub and a local copy. I'm developing with tools that read an openAPI spec and I currently need to save to swaggerhub then download to local dev environment.

How can I configure the plugin so that I I use the GitLab Integration?

It is possible to create a branch on the defined gitlab integration when a new yaml file is created and also to have to possibility to push changes to gitlab from visual studio code?

Do you have or plan to have the ability to export resolved yaml/json

Do you have or plan to have the ability to export resolved yaml/json?
It is not obvious from the extension's UI whether this is supported currently. It would be nice if we can export resolved APIs from VS Code.

Plugin not closing down VSCode problems when APIs are closed

When I close an API definition, its normal for any problems that are registered against the opened file to be purged in VS Code.

This does not happen with the current version of the plugin.

Workaround is to close VSCode and re-open it.

To get some problems, suggest installing https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker and introducing spelling mistakes in a definition. On close the terminal errors remain and if you open another definition they are still there confusing the editor.

Unable to verify the first certificate

After going into the settings for the extension, I am presented with an error stating that 'Unable to verify the first certificate". When I cut and paste the request into my browser, the request succeeds and I am presented with a list of APIs. Which certificate is causing the problem and how do I go about fixing this?

Linting/Standard/Validation support

Does this extension support inline linting (including organization level standards) similar to SwaggerHub UI?

Unable to verify the first certificate

When trying to access an on-prem installation of SwaggerHub from VS Code, I am receiving this error. I have reviewed issue #6 and nothing that is stated in the reference material works. I am able to cut and paste the request into a Chrome and I am able to get results, so it appears not to be an issue with certificates not being installed on my laptop. What else can I look at in trying to get this plug-in to work?

Can't load APIs

Clicking Load APIs give the following error:

invalid json response body at https://app.swaggerhub.com/apis/JackS9?page=0&limit=100&sort=NAME&order=ASC reason: Unexpected token '<', "<!doctype "... is not valid JSON