External file $refs not supported by jump to definition

[dodongo]

A ref like the following doesn't support jump to definition, though it seems like it should be supported by the spec:

"schema": {
  "$ref": "./common_schemas.json#/CustomType"
}

where common_schemas.json is in the same directory and contains:

{
  "CustomType": {
    "description": "A custom type.",
    "type": "string"
  }
}

[ak1394]

You are correct, current implementation does not support opening external files. I'll look into supporting this in the next release.

[dodongo]

@ak1394 One other note. Not sure if this would end up getting covered by the same fix, but in terms of getting the overview OpenAPI pane reflecting all the currently used data types - i.e:

to reflect components that are in external refs, would the standard practice be to have the component still be listed in a specific openapi.json spec under internal components, and then referenced externally? i.e.:

"components": {
    "parameters": {
      "CustomParameter": {
        "$ref": "./common_parameters.json#/CustomParameter"
      },
...

Otherwise if using external refs inline like:

"paths": {
    "/some/path": {
      "post": {
        "operationId": "some_path_post",
        "summary": "Some Path Post",
        "description": "Some Path Post Description.",
        "parameters": [
          {
            "$ref": "./common_parameters.json#/CustomParameter"
          },
...

I would image the tooling would have no other way of actually displaying what components are being used on the overview pane. Unless there's plans for a separate section for external types?

[ak1394]

Indeed. For the time being the outline is pretty simple and it pretty much follows the structure of the OpenAPI file itself. Operations for example don't list their parameters in the outline at all and components/parameters simply display parameter names without making distinction between inline/external definitions. This is something for us to figure out for the future versions.

[ak1394]

The $refs issue has been fixed in the new v1.8.10. I'm going to close this issue, but feel free to comment (or open new issue) if you have further thoughts on displaying of types in the outline.