Need to document non-API interface

[kineticsquid]

For compatibility reasons, in addition to the documented API, open-vsx.org also duplicates the VS Registry Interface, e.g.,

/vscode/asset/../Microsoft.VisualStudio.Services.Icons.Default
/vscode/unpkg/../package.json
/vscode/gallery/itemName/../vscodewebextension
/vscode/gallery/extensionquery?
/vscode/item?itemName=ban.spellright

These are some examples from our access logs. What's the best way to get a complete list of these URLs the server responds to?

[kineticsquid]

@filiptronicek?

[amvanbaren]

Here's a preview of the VS Code adapter documentation: https://staging.open-vsx.org/swagger-ui/index.html?urls.primaryName=VSCode%20Adapter

[kineticsquid]

@amvanbaren Looks good. I my scan of the logs, I also picked up some of these: /vscode/gallery/itemName/../vscodewebextension

[kineticsquid]

@filiptronicek Any comments?

[filiptronicek]

@kineticsquid from https://github.com/eclipse/openvsx/blob/c317d0d3aeed94ad752b05d2539f6c4f483ed8ec/server/src/main/java/org/eclipse/openvsx/adapter/VSCodeAPI.java, I see:

• /vscode/gallery/extensionquery
• /vscode/asset/{namespaceName}/{extensionName}/{version}/{assetType}/**
• /vscode/item
• /vscode/gallery/publishers/{namespaceName}/vsextensions/{extensionName}/{version}/vspackage
• /vscode/unpkg/{namespaceName}/{extensionName}/{version}/**

[amvanbaren]

@kineticsquid Open VSX doesn't have a /vscodewebextension endpoint. Let me check if we need to add this endpoint.

[amvanbaren]

The /vscodewebextension endpoint is for reporting statistics (telemetry).

https://github.com/microsoft/vscode/blob/e023ea2c7c5ec54334977c7f1ecd83f031843794/src/vs/platform/extensionManagement/common/extensionGalleryService.ts#L1096-L1113

[kineticsquid]

I checked the logs I have and sampled references to the /vscodewebextension endpoint. All returned 404s. So we're good to publish this.

My intent is to put a link to the Swagger on this wiki page: https://github.com/EclipseFdn/open-vsx.org/wiki/Compatibility-Interface. The text will read, 'The following Swagger documents the VS Marketplace interfaces implemented by Open VSX to ensure compatibility.'

[kineticsquid]

OK, link is published: https://github.com/EclipseFdn/open-vsx.org/wiki/Compatibility-Interface.

I also submitted an update to point the 'Documentation' link on the menu bar to https://github.com/EclipseFdn/open-vsx.org/wiki instead of https://github.com/eclipse/openvsx/wiki. I think this makes more sense given the documentation is deployment specific.

That said, the compatibility interface we just documented is not, do we want to put a pointer to the Swagger doc on https://github.com/eclipse/openvsx/wiki?

[kineticsquid]

@amvanbaren I can see my PR was merged to change the URL at the 'Docmentation' link to point to https://github.com/EclipseFdn/open-vsx.org/wiki instead of https://github.com/eclipse/openvsx/wiki. And I thought I saw it deployed. But the link still points to https://github.com/EclipseFdn/open-vsx.org/wiki. Am I missing something?

[amvanbaren]

The documentation link in the mobile menu points to https://github.com/EclipseFdn/open-vsx.org/wiki

But the documentation link in the default menu doesn't.

You also need to change this line:

open-vsx.org/website/src/menu-content.tsx

Line 185 in f59418d

<MenuLink href='https://github.com/eclipse/openvsx/wiki'>

[kineticsquid]

@amvanbaren Thanks for the pointer. Here's a PR to fix that: #3164