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
The [OpenAPI-Format Playground](https://openapi-format-playground.vercel.app/) is a web-based tool for formattingand sorting OpenAPI documents, powered by the openapi-format CLI.
100
+
The [OpenAPI-Format Playground](https://playground.openapi-format.com/) is a web-based tool for formatting, sorting, filtering, previewing, and comparing OpenAPI documents, powered by the `openapi-format` CLI.
More info about the features and usage, can be found in the [readme](https://github.com/thim81/openapi-format-playground?tab=readme-ov-file#features).
111
+
More info about the playground features and usage can be found on the [website](https://openapi-format.com/).
109
112
110
113
## Installation
111
114
@@ -329,7 +332,7 @@ paths:
329
332
### Filter - tags
330
333
331
334
=> **tags**: Refers to the "tags" field from the "Operation
Fore more information about the OpenAPI Overlay options, see [OpenAPI Overlay Specification 1.0.0](https://www.openapis.org/blog/2024/10/22/announcing-overlay-specification)
1233
+
Fore more information about the OpenAPI Overlay options, see [OpenAPI Overlay Specification 1.0.0](https://www.openapis.org/blog/2024/10/22/announcing-overlay-specification)
1231
1234
1232
1235
Use the `--overlayFile` option to specify the overlay file and apply it to your OpenAPI document.
1233
1236
@@ -1366,7 +1369,7 @@ Example: Splitting the Document
This command will take the openapi.json and split it into multiple files, stored under the ./openapi-split/ directory.
1372
+
This command will take the openapi.json and split it into multiple files, stored under the ./openapi-split/ directory.
1370
1373
1371
1374
The resulting structure might look like this:
1372
1375
@@ -1388,7 +1391,7 @@ The main openapi.yaml file will contain references to these newly created files
1388
1391
1389
1392
### Bundling the OpenAPI Document
1390
1393
1391
-
The `--no-bundle` option allows you to control whether local and remote $ref references are bundled into the final document.
1394
+
The `--no-bundle` option allows you to control whether local and remote $ref references are bundled into the final document.
1392
1395
1393
1396
By default, all $ref references are dereferenced, resulting in a single, self-contained OpenAPI file. However, in some cases, you might prefer to keep the $ref references intact, especially if you're working with external references or want to maintain a modular structure.
1394
1397
@@ -1525,42 +1528,42 @@ You can either pass the settings inline or reference an external file using the
1525
1528
1526
1529
- **sortSet** / **sortFile**: Sort the fields in the OpenAPI document based on the order defined in the sort settings.
1527
1530
1528
-
- Inline: Pass the sort order directly using sortSet in the config file.
1529
-
- File: Use sortFile to specify the path to a local or remote JSON/YAML file containing custom sorting rules.
1531
+
- Inline: Pass the sort order directly using sortSet in the config file.
1532
+
- File: Use sortFile to specify the path to a local or remote JSON/YAML file containing custom sorting rules.
1530
1533
1531
1534
- **casingSet** / **casingFile**: Define the casing convention for operationId, parameters, properties, etc.
1532
1535
1533
-
- Inline:
1534
-
```json
1535
-
"casingSet": {
1536
-
"operationId": "camelCase",
1537
-
"properties": "PascalCase"
1538
-
}
1539
-
```
1536
+
- Inline:
1537
+
```json
1538
+
"casingSet": {
1539
+
"operationId": "camelCase",
1540
+
"properties": "PascalCase"
1541
+
}
1542
+
```
1540
1543
1541
-
- File: Use casingFile to specify the path to a local or remote JSON/YAML file containing casing rules.
1544
+
- File: Use casingFile to specify the path to a local or remote JSON/YAML file containing casing rules.
1542
1545
1543
1546
- **filterSet** / **filterFile**: Filter out specific tags, paths, or components from the OpenAPI document.
1544
1547
1545
-
- Inline:
1546
-
```json
1547
-
"filterSet": {
1548
-
"tags": ["internal", "beta"]
1549
-
}
1550
-
```
1548
+
- Inline:
1549
+
```json
1550
+
"filterSet": {
1551
+
"tags": ["internal", "beta"]
1552
+
}
1553
+
```
1551
1554
1552
-
- File: Use filterFile to specify the path to a local or remote JSON/YAML file containing filter rules.
1555
+
- File: Use filterFile to specify the path to a local or remote JSON/YAML file containing filter rules.
1553
1556
1554
1557
- **generateSet** / **generateFile**: Automatically generate operationId, summary, and other elements based on predefined templates.
0 commit comments