@accelbyte/codegen 3.0.6 → 4.0.0
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/PATCHING.md +1 -1
- package/README.md +3 -3
- package/dist/accelbyte-codegen.js +1329 -950
- package/dist/accelbyte-codegen.js.map +1 -1
- package/dist/accelbyte-codegen.mjs +1308 -928
- package/dist/accelbyte-codegen.mjs.map +1 -1
- package/package.json +22 -6
- package/scripts/get-swaggers-configs.mjs +54 -0
package/PATCHING.md
CHANGED
|
@@ -72,7 +72,7 @@ For example, take a look at the this object
|
|
|
72
72
|
}
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
This definition says that `TokenResponseV3` will always give out `xuid`. Yet at the moment, that property shouldn't always appear in the current IAM and the Swagger JSON is mistakenly written that way. If we kept the `xuid` property there, the response validation in the
|
|
75
|
+
This definition says that `TokenResponseV3` will always give out `xuid`. Yet at the moment, that property shouldn't always appear in the current IAM and the Swagger JSON is mistakenly written that way. If we kept the `xuid` property there, the response validation in the TypeScript SDK will throw error and say the response missed the `xuid` property. Therefore, the JSON Patches are created, and it looks like this
|
|
76
76
|
|
|
77
77
|
```
|
|
78
78
|
{
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# AccelByte
|
|
1
|
+
# AccelByte TypeScript SDK Code Generator
|
|
2
2
|
|
|
3
|
-
AccelByte Code Generator is a CLI tool that facilitates creating an AccelByte
|
|
3
|
+
AccelByte Code Generator is a CLI tool that facilitates creating an AccelByte TypeScript SDK from AccelByte OpenAPI definitions.
|
|
4
4
|
|
|
5
5
|
## CLI
|
|
6
6
|
This codegen build a CLI called `accelbyte-codegen` that will be used to generate code from given config.
|
|
@@ -80,7 +80,7 @@ yarn accelbyte-codegen download-swaggers --config ./config.json --swaggersOutput
|
|
|
80
80
|
```
|
|
81
81
|
*note: please adjust the `--config` flag with the path of config.json file that was already set up before, and please specify the swagger output directory by using `--swaggersOutput` flag.
|
|
82
82
|
|
|
83
|
-
**Step 6: Generate Code from Swagger Files** after the swagger file has already been downloaded we can proceed to generating
|
|
83
|
+
**Step 6: Generate Code from Swagger Files** after the swagger file has already been downloaded we can proceed to generating TypeScript SDK code from the Swagger File using this command :
|
|
84
84
|
```
|
|
85
85
|
npm exec -- accelbyte-codegen generate-code --config ./config.json --swaggersOutput ./swaggers --output ./sdk
|
|
86
86
|
```
|