You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SpecLynx OpenAPI Toolkit is engineered for clarity, control, and confidence, enabling you to focus on designing exceptional APIs.
16
16
@@ -47,93 +47,97 @@ We are actively expanding the feature set and fixing bugs; this documentation wi
47
47
48
48
#### Foreword
49
49
50
-
**JSON and YAML** — OpenAPI Toolkit provides the same level of support for OpenAPI specs written in JSON or YAML. It also aims to provide editor capabilities even for not-well-formed documents (for example, offering completion and syntax highlighting where possible).
50
+
**JSON and YAML** — OpenAPI Toolkit provides the same level of support for OpenAPI specs written in JSON or YAML format. It also aims to provide editor capabilities even for not-well-formed documents (for example, offering completion and syntax highlighting where possible).
51
51
52
-
**Swagger/OpenAPI 2.0, OpenAPI 3.0, and 3.1** — OpenAPI Toolkit supports all of these versions with a consistent feature set.
52
+
OpenAPI Toolkit supports following OpenAPI versions with a consistent feature set:
**Web support** — OpenAPI Toolkit is designed to run both on Desktop and in Web environments such as [vscode.dev](https://vscode.dev/), [github.dev](https://github.dev/), and [GitHub Codespaces](https://github.com/features/codespaces). It is one of the few extensions that deliver advanced OpenAPI editing and validation/linting in the web environment. 
61
71
62
72
#### In-context OpenAPI Documentation (hover)
63
73
64
74
When you hover over a keyword (node key) in the document, the extension shows full, context-aware documentation in a hover panel that corresponds to the selected construct and matches the official specification.
The same documentation is also shown in the details pane of completion items. See the “Completion / Suggestions” section below. 
70
79
71
80
#### Completion / Suggestions
72
81
73
82
OpenAPI Toolkit provides an enriched completion experience. Under the hood, completion is driven by a semantic understanding of the node where completion is triggered, making suggestions far more precise and useful than standard JSON-Schema-based completion. 
74
83
75
-
##### Completion docs
84
+
##### Completion documentation
76
85
77
86
Each completion item includes full documentation (the same content shown in hover).
78
87
**Tip:** If the documentation panel doesn’t appear to the right of the completion label, click the `>` icon that appears when you hover the completion entry. 
When completion is triggered within the value of a `$ref` field, the editor offers suggestions of compatible targets found in the document (this will be expanded to include documents across the workspace). It also displays the referenced content in the completion box, providing an in-context view of potential references without losing focus 
Hovering over the value of a `$ref` field displays the referenced content in the hover box, providing an in-context view of references without losing focus. 
Right-click the value of a `$ref` field and choose **Go to Definition** (or press **F3**) to jump to the reference target—either within the current file or in another file in the workspace. 
111
117
112
118
##### Go to references
113
119
114
120
Right-click a key (for example, under `components.schemas`) and choose **Go to References** to open a panel listing available references to jump to. 
118
123
119
124
##### Find all references
120
125
121
126
Right-click a key (for example, of a schema) and choose **Find All References** to open the References panel listing every usage of the selected target. 
124
129
125
130
##### Dereference command
126
131
127
132
Right-click inside an OpenAPI document or right-click the file in the Explorer, then choose **OpenAPI Toolkit → Dereference API Document** to save a dereferenced copy locally. The default output name is `{filename}-dereferenced.{extension}`. 
OpenAPI Toolkit provides **semantic** syntax highlighting, going beyond basic keyword coloring. Specific OpenAPI elements—such as operations, schemas, and reference objects—are highlighted with distinct colors and font styles. This helps you quickly recognize and distinguish different parts of an API definition, improving readability and navigation in complex specifications. 
The Preview panel (powered by [SwaggerUI](https://github.com/swagger-api/swagger-ui)) renders the current OpenAPI document and lets you interact with it.
236
+
Preview panel can be opened by opening the Command Palette (CTRL+Shift+P) and running the `OpenAPI Toolkit: Show API Document preview` command.
0 commit comments