@shopware/api-gen 1.0.5 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -3
- package/dist/cli.mjs +6356 -4978
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -5,6 +5,8 @@ Generate TypeScript schemas from Shopware OpenAPI specification.
|
|
|
5
5
|
|
|
6
6
|
After generating schemas, you can use them in fully typed [API Client](https://www.npmjs.com/package/@shopware/api-client).
|
|
7
7
|
|
|
8
|
+
To take a deep dive into the topic visit the [🧑🎓 API Client Tutorial](https://api-client-tutorial-composable-frontends.pages.dev) first.
|
|
9
|
+
|
|
8
10
|
## Usage
|
|
9
11
|
|
|
10
12
|
<!-- automd:pm-install name="@shopware/api-gen" dev -->
|
|
@@ -41,7 +43,7 @@ If your instance contains inacurate or outdated OpenAPI specification, you can o
|
|
|
41
43
|
|
|
42
44
|
Example of overrides file:
|
|
43
45
|
|
|
44
|
-
<!-- automd:file src="
|
|
46
|
+
<!-- automd:file src="packages/api-gen/tests/snapshots-override/simpleOverride.example.ts" code -->
|
|
45
47
|
|
|
46
48
|
```ts [simpleOverride.example.ts]
|
|
47
49
|
import { components as mainComponents } from "./storeApiTypes";
|
|
@@ -227,14 +229,22 @@ Prepare your config file named **api-gen.config.json**:
|
|
|
227
229
|
}
|
|
228
230
|
```
|
|
229
231
|
|
|
232
|
+
## Links
|
|
233
|
+
|
|
234
|
+
- [🧑🎓 Tutorial](https://api-client-tutorial-composable-frontends.pages.dev)
|
|
235
|
+
|
|
236
|
+
- [📘 Documentation](https://frontends.shopware.com)
|
|
237
|
+
|
|
238
|
+
- [👥 Community Slack](https://shopwarecommunity.slack.com) (`#composable-frontends` channel)
|
|
239
|
+
|
|
230
240
|
<!-- AUTO GENERATED CHANGELOG -->
|
|
231
241
|
|
|
232
242
|
## Changelog
|
|
233
243
|
|
|
234
244
|
Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/api-gen/CHANGELOG.md)
|
|
235
245
|
|
|
236
|
-
### Latest changes: 1.
|
|
246
|
+
### Latest changes: 1.1.1
|
|
237
247
|
|
|
238
248
|
### Patch Changes
|
|
239
249
|
|
|
240
|
-
- [
|
|
250
|
+
- [`b550cef`](https://github.com/shopware/frontends/commit/b550ceffac00f23a533d4f3913d2a801d3892c69) Thanks [@patzick](https://github.com/patzick)! - Fix process failing on errors to give more time for adoption.
|