@ama-sdk/schematics 12.3.0-prerelease.13 → 12.3.0-prerelease.14
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
CHANGED
|
@@ -119,9 +119,27 @@ For more information, check out OpenAPI's documentation on [parameter serializat
|
|
|
119
119
|
It is important to note that, as in OpenAPI 3.1, we only support simple arrays and simple non-nested objects in path and query parameters.
|
|
120
120
|
The parameter types that we support are stored in `SupportedParamType` in the package `@ama-sdk/core`.
|
|
121
121
|
|
|
122
|
+
To enable the parameter serialization within your API, you can set the option `enableParameterSerialization` to `true` (its current default value is `false`) in the constructor. For example:
|
|
123
|
+
```typescript
|
|
124
|
+
const apiConfig: ApiClient = new ApiFetchClient(
|
|
125
|
+
{
|
|
126
|
+
basePath: 'https://petstore3.swagger.io/api/v3',
|
|
127
|
+
enableParameterSerialization: true
|
|
128
|
+
}
|
|
129
|
+
);
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
We provide the methods `serializeQueryParams` and `serializePathParams` to serialize the values of query and path parameters. However, it is also possible to pass
|
|
133
|
+
your own serialization methods if the ones provided do not meet your requirements. These custom methods can be passed as a parameter to the API client constructor.
|
|
134
|
+
|
|
135
|
+
> [!NOTE]
|
|
136
|
+
> If you have enabled the serialization mechanism and want to update the query parameters within a `RequestPlugin`, these must be serialized before being returned to the
|
|
137
|
+
> API to prepare the URL. You can do so by using the serialization method that we provide (`serializeQueryParams`) or your own serialization method. The value of the query
|
|
138
|
+
> parameters returned by the `RequestPlugin` will be forwarded to the next plugin and the last value will be directly added to the URL.
|
|
139
|
+
|
|
122
140
|
> [!NOTE]
|
|
123
|
-
>
|
|
124
|
-
>
|
|
141
|
+
> It is important to note that special characters have to be encoded, as required by RFC6570 and RFC3986. Please take this into account if you choose to use your own
|
|
142
|
+
> serialization methods.
|
|
125
143
|
|
|
126
144
|
#### Light SDK
|
|
127
145
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ama-sdk/schematics",
|
|
3
|
-
"version": "12.3.0-prerelease.
|
|
3
|
+
"version": "12.3.0-prerelease.14",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -62,12 +62,12 @@
|
|
|
62
62
|
}
|
|
63
63
|
},
|
|
64
64
|
"peerDependencies": {
|
|
65
|
-
"@ama-sdk/core": "^12.3.0-prerelease.
|
|
65
|
+
"@ama-sdk/core": "^12.3.0-prerelease.14",
|
|
66
66
|
"@angular-devkit/core": "^19.0.0",
|
|
67
67
|
"@angular-devkit/schematics-cli": "^19.0.0",
|
|
68
68
|
"@angular/cli": "^19.0.0",
|
|
69
|
-
"@o3r/schematics": "^12.3.0-prerelease.
|
|
70
|
-
"@o3r/telemetry": "^12.3.0-prerelease.
|
|
69
|
+
"@o3r/schematics": "^12.3.0-prerelease.14",
|
|
70
|
+
"@o3r/telemetry": "^12.3.0-prerelease.14",
|
|
71
71
|
"@openapitools/openapi-generator-cli": "^2.15.0",
|
|
72
72
|
"openapi-types": "^12.0.0",
|
|
73
73
|
"ts-node": "~10.9.2",
|
|
@@ -86,17 +86,17 @@
|
|
|
86
86
|
"tslib": "^2.6.2"
|
|
87
87
|
},
|
|
88
88
|
"devDependencies": {
|
|
89
|
-
"@ama-sdk/core": "^12.3.0-prerelease.
|
|
89
|
+
"@ama-sdk/core": "^12.3.0-prerelease.14",
|
|
90
90
|
"@angular-devkit/schematics-cli": "~19.2.0",
|
|
91
91
|
"@angular/cli": "~19.2.0",
|
|
92
92
|
"@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
|
|
93
93
|
"@nx/eslint-plugin": "~20.7.0",
|
|
94
94
|
"@nx/jest": "~20.7.0",
|
|
95
|
-
"@o3r/build-helpers": "^12.3.0-prerelease.
|
|
96
|
-
"@o3r/eslint-plugin": "^12.3.0-prerelease.
|
|
97
|
-
"@o3r/schematics": "^12.3.0-prerelease.
|
|
98
|
-
"@o3r/telemetry": "^12.3.0-prerelease.
|
|
99
|
-
"@o3r/test-helpers": "^12.3.0-prerelease.
|
|
95
|
+
"@o3r/build-helpers": "^12.3.0-prerelease.14",
|
|
96
|
+
"@o3r/eslint-plugin": "^12.3.0-prerelease.14",
|
|
97
|
+
"@o3r/schematics": "^12.3.0-prerelease.14",
|
|
98
|
+
"@o3r/telemetry": "^12.3.0-prerelease.14",
|
|
99
|
+
"@o3r/test-helpers": "^12.3.0-prerelease.14",
|
|
100
100
|
"@openapitools/openapi-generator-cli": "~2.18.0",
|
|
101
101
|
"@schematics/angular": "~19.2.0",
|
|
102
102
|
"@stylistic/eslint-plugin": "~3.1.0",
|
|
Binary file
|