Skip to content

Commit 1b36258

Browse files
char0nchar0n
authored
fix(README): allow screenshots to autoscale (#11)
Closes #7
1 parent 3bb65a8 commit 1b36258

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ We are actively expanding the feature set and fixing bugs; this documentation wi
5252
**Swagger/OpenAPI 2.0, OpenAPI 3.0, and 3.1** — OpenAPI Toolkit supports all of these versions with a consistent feature set.
5353

5454

55-
<img width="792" height="785" alt="image" src="https://github.com/user-attachments/assets/3d2f492d-181c-4952-9784-137411d76590" />
56-
<img width="948" height="1173" alt="image" src="https://github.com/user-attachments/assets/6a97d11c-47da-4c28-aeca-60305bdbe95d" />
55+
<img alt="image" src="https://github.com/user-attachments/assets/3d2f492d-181c-4952-9784-137411d76590" />
56+
<img alt="image" src="https://github.com/user-attachments/assets/6a97d11c-47da-4c28-aeca-60305bdbe95d" />
5757

5858
<br><br>
5959

@@ -63,7 +63,7 @@ We are actively expanding the feature set and fixing bugs; this documentation wi
6363

6464
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.
6565

66-
<img width="1562" height="573" alt="image" src="https://github.com/user-attachments/assets/7aaf568d-9a2f-4d4f-bb63-9d38db654579" />
66+
<img alt="image" src="https://github.com/user-attachments/assets/7aaf568d-9a2f-4d4f-bb63-9d38db654579" />
6767

6868

6969
The same documentation is also shown in the details pane of completion items. See the “Completion / Suggestions” section below.&#x20;
@@ -77,20 +77,20 @@ OpenAPI Toolkit provides an enriched completion experience. Under the hood, comp
7777
Each completion item includes full documentation (the same content shown in hover).
7878
**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.&#x20;
7979

80-
<img width="916" height="403" alt="image" src="https://github.com/user-attachments/assets/1d90a38b-427a-4b23-a8f8-aeaa1aa2d448" />
80+
<img alt="image" src="https://github.com/user-attachments/assets/1d90a38b-427a-4b23-a8f8-aeaa1aa2d448" />
8181

8282
##### References completion
8383

8484
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&#x20;
8585

86-
<img width="1008" height="440" alt="image" src="https://github.com/user-attachments/assets/d293593c-332a-4183-abca-5cbf944176cb" />
86+
<img alt="image" src="https://github.com/user-attachments/assets/d293593c-332a-4183-abca-5cbf944176cb" />
8787

8888

8989
##### Context-aware completion (e.g., `type: integer` → `format`)
9090

9191
Suggestions adapt to related fields. For example, if a schema sets `type: integer`, the `format` suggestions include only compatible values.&#x20;
9292

93-
<img width="967" height="448" alt="image" src="https://github.com/user-attachments/assets/6ef34a33-f7b4-4341-9edb-e8641e626914" />
93+
<img alt="image" src="https://github.com/user-attachments/assets/6ef34a33-f7b4-4341-9edb-e8641e626914" />
9494

9595

9696
#### References
@@ -99,41 +99,41 @@ Suggestions adapt to related fields. For example, if a schema sets `type: intege
9999

100100
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.&#x20;
101101

102-
<img width="657" height="521" alt="image" src="https://github.com/user-attachments/assets/4882f6e3-7b13-4cd7-84ab-8ce2e3a4081c" />
102+
<img alt="image" src="https://github.com/user-attachments/assets/4882f6e3-7b13-4cd7-84ab-8ce2e3a4081c" />
103103

104104

105105

106106
##### Go to definition (F3)
107107

108108
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.&#x20;
109109

110-
<img width="699" height="401" alt="image" src="https://github.com/user-attachments/assets/a5c1610a-1c06-4c8d-8316-46f953755cd8" />
110+
<img alt="image" src="https://github.com/user-attachments/assets/a5c1610a-1c06-4c8d-8316-46f953755cd8" />
111111

112112
##### Go to references
113113

114114
Right-click a key (for example, under `components.schemas`) and choose **Go to References** to open a panel listing available references to jump to.&#x20;
115115

116-
<img width="2070" height="385" alt="image" src="https://github.com/user-attachments/assets/2cb17ad2-cd43-4945-94a7-746c6397a82a" />
116+
<img alt="image" src="https://github.com/user-attachments/assets/2cb17ad2-cd43-4945-94a7-746c6397a82a" />
117117

118118

119119
##### Find all references
120120

121121
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.&#x20;
122122

123-
<img width="902" height="459" alt="image" src="https://github.com/user-attachments/assets/9b00b3b1-03f3-4252-b7b9-4a853f00783d" />
123+
<img alt="image" src="https://github.com/user-attachments/assets/9b00b3b1-03f3-4252-b7b9-4a853f00783d" />
124124

125125
##### Dereference command
126126

127127
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}`.&#x20;
128128

129-
<img width="805" height="450" alt="image" src="https://github.com/user-attachments/assets/e7bc9c2b-95be-4508-8212-1f2dd99334c3" />
129+
<img alt="image" src="https://github.com/user-attachments/assets/e7bc9c2b-95be-4508-8212-1f2dd99334c3" />
130130

131131

132132
#### Syntax Highlighting
133133

134134
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.&#x20;
135135

136-
<img width="1303" height="1108" alt="image" src="https://github.com/user-attachments/assets/b67c64b5-771d-4eb1-81d3-359872e7607b" />
136+
<img alt="image" src="https://github.com/user-attachments/assets/b67c64b5-771d-4eb1-81d3-359872e7607b" />
137137

138138
#### Validation and Linting
139139

@@ -152,7 +152,7 @@ OpenAPI Toolkit supports three modes, which you can combine:
152152
2. **Spectral validation and linting**
153153
3. **Semantic validation and linting**&#x20;
154154

155-
<img width="1198" height="1204" alt="image" src="https://github.com/user-attachments/assets/36d55b1d-6cfa-41db-8656-1242e3e946c0" />
155+
<img alt="image" src="https://github.com/user-attachments/assets/36d55b1d-6cfa-41db-8656-1242e3e946c0" />
156156

157157
##### Default configuration
158158

@@ -169,15 +169,15 @@ To enable Spectral-based checks:
169169

170170
Refer to the [Spectral documentation](https://docs.stoplight.io/docs/spectral/) for ruleset format details.&#x20;
171171

172-
<img width="1325" height="281" alt="image" src="https://github.com/user-attachments/assets/1cb7691d-7fba-4b82-96b8-3a0344aa2ba4" />
172+
<img alt="image" src="https://github.com/user-attachments/assets/1cb7691d-7fba-4b82-96b8-3a0344aa2ba4" />
173173

174-
<img width="802" height="396" alt="image" src="https://github.com/user-attachments/assets/2bfd9175-a42b-43e2-96ad-1217b60bebcd" />
174+
<img alt="image" src="https://github.com/user-attachments/assets/2bfd9175-a42b-43e2-96ad-1217b60bebcd" />
175175

176176
##### Semantic validation
177177

178178
Enable **Apply Semantic Validation** in the extension settings. No rules file is required to run the built-in semantic validation checks.&#x20;
179179

180-
<img width="881" height="108" alt="image" src="https://github.com/user-attachments/assets/6245a7f4-71d2-46f9-a271-b031728ace4c" />
180+
<img alt="image" src="https://github.com/user-attachments/assets/6245a7f4-71d2-46f9-a271-b031728ace4c" />
181181

182182
##### Semantic linting
183183

@@ -198,7 +198,7 @@ Semantic lint rules are defined in JSON or YAML. A ruleset typically includes:
198198
* **Condition(s)** to evaluate (e.g., required fields, naming patterns, min/max constraints)
199199
* **Optional fixes** or suggestions (when applicable)
200200

201-
<img width="626" height="318" alt="image" src="https://github.com/user-attachments/assets/a2f3e0d8-8178-43a6-b26c-f1678b3a7622" />
201+
<img alt="image" src="https://github.com/user-attachments/assets/a2f3e0d8-8178-43a6-b26c-f1678b3a7622" />
202202

203203
A separate section provides the complete rule schema and examples. *(If you don’t see it yet, it will be added as the rules stabilize.)*&#x20;
204204

0 commit comments

Comments
 (0)