Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -301,13 +312,13 @@
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -303,13 +314,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -454,13 +465,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -322,13 +333,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -303,13 +314,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -468,13 +479,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
Returns
The request builder itself, to facilitate method chaining.
@@ -322,13 +333,13 @@
Returns
The request builder itself, to facilitate method chaining.
Sets user-defined identifier for the batch reference.
+
Replace the default service path with the given custom path.
+In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
+
+
Returns
The request builder itself, to facilitate method chaining.
Parameters
-
id: string
-
User-defined batch request identifier.
+
basePath: string
+
Path to override the default with.
-
Returns void
-
-
setCustomServicePath
+
Defined in packages/odata-common/dist/request-builder/request-builder-base.d.ts:53
Replace the default service path with the given custom path.
-In case of the SAP S/4HANA APIs the servicePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.
-
-
Returns
The request builder itself, to facilitate method chaining.
+
Sets user-defined identifier for the batch reference.
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
+
\ No newline at end of file
diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html
index d36be5b89f..f38e68dea2 100644
--- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html
+++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html
@@ -1,5 +1,5 @@
-encodeAllParameters | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+encodeAllParameters | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html
index eb47f97af2..3ea0f395f0 100644
--- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html
+++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html
@@ -1,5 +1,5 @@
-circuitBreakerHttp | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+circuitBreakerHttp | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html b/knowledge-base/api-reference/interfaces/generatorcommon_src.CommonGeneratorOptions.html
similarity index 59%
rename from knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html
rename to knowledge-base/api-reference/interfaces/generatorcommon_src.CommonGeneratorOptions.html
index 12859480a7..153b33ae7c 100644
--- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html
+++ b/knowledge-base/api-reference/interfaces/generatorcommon_src.CommonGeneratorOptions.html
@@ -1,5 +1,5 @@
-GeneratorOptions | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+CommonGeneratorOptions | SAP Cloud SDK for JavaScript - v3.0.0
Remove all files in the output directory before generation.
-Be cautious when using this option, as it really removes EVERYTHING in the output directory.
+
Delete EVERYTHING in the specified output directory before generating code.
+
Defined in packages/generator-common/dist/options.d.ts:111
Optionalinclude
include?:string
Include files matching the given glob into the root of each generated client directory.
+
Defined in packages/generator-common/dist/options.d.ts:115
input
input:string
-
Specify the path to the directory or file containing the OpenAPI service definition(s) to generate clients for.
-Accepts Swagger and OpenAPI definitions as YAML and JSON files.
+
Specify the path to the directory or file containing the service definition(s) to generate clients for.
Throws an error if the path does not exist.
+
Defined in packages/generator-common/dist/options.d.ts:100
Optionalmetadata
metadata?:boolean
Hidden option only for internal usage - generate metadata for API hub integration.
+
Defined in packages/generator-common/dist/options.d.ts:119
OptionaloptionsPerService
optionsPerService?:string
-
Set the path to a file containing the options per service.
-The configuration allows to set a directoryName and packageName for every service, identified by the path to the original file.
+
Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files.
+The configuration allows to set a directoryName and npmPackageName for every service, identified by the path to the original file.
It also makes sure that names do not change between generator runs.
If a directory is passed, a options-per-service.json file is read/created in this directory.
+
Defined in packages/generator-common/dist/options.d.ts:107
outputDir
outputDir:string
-
Specify the path to the directory to generate the client(s) in.
-Each client is generated into a subdirectory within the given output directory.
-Creates the directory if it does not exist.
-Customize subdirectory naming through optionsPerService.
+
Directory to save the generated code in.
+
Defined in packages/generator-common/dist/options.d.ts:123
Optionaloverwrite
overwrite?:boolean
-
Allow overwriting files that already exist.
-This is useful when running the generation regularly.
+
Exit when encountering a file that already exists.
+When set to true, it will be overwritten instead.
+Note, that compared to the clearOutputDir option, this will not delete outdated files.
+
Defined in packages/generator-common/dist/options.d.ts:133
OptionalpackageJson
packageJson?:boolean
-
When enabled, a package.json containing dependencies and scripts for transpilation and documentation generation, is generated.
-
-
-
OptionalpackageVersion
-
packageVersion?:string
-
Internal option used to adjust the version in the generated package.json. Will not be used in the future.
+
Generate a package.json file, specifying dependencies and scripts for compiling.
+
Defined in packages/generator-common/dist/options.d.ts:127
OptionalprettierConfig
prettierConfig?:string
Specify the path to the prettier config. If not given a default config will be used for the generated sources.
+
Defined in packages/generator-common/dist/options.d.ts:158
Optionalreadme
readme?:boolean
Generate default README.md files in the client directories.
+
Defined in packages/generator-common/dist/options.d.ts:162
OptionalskipValidation
skipValidation?:boolean
-
By default, the generation fails when there are duplicate or invalid names for operations and/or path parameters after transforming them to camel case.
-Set this to true to enable unique and valid name generation.
-The names will then be generated by appending numbers and prepending prefixes.
+
Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords.
+If you enable this option, conflicts are resolved by appending postfixes like '_1".
+
Defined in packages/generator-common/dist/options.d.ts:143
Optionaltranspile
transpile?:boolean
-
Transpile the generated TypeScript code.
-When enabled, a default tsconfig.json will be generated and used.
-It emits .js, .js.map, .d.ts and .d.ts.map files.
-To configure transpilation set tsconfig.
+
When enabled, generates transpiled .js, .js.map, and .d.ts files.
+By default, only .ts files are generated.
+
Defined in packages/generator-common/dist/options.d.ts:148
Optionaltsconfig
tsconfig?:string
@@ -165,14 +152,15 @@
Optionaltsconfig.json file is read from this directory.
+
Defined in packages/generator-common/dist/options.d.ts:154
Optionalverbose
verbose?:boolean
-
Turn on verbose logging.
+
By default, only errors, warnings and important info logs will be displayed.
+If set to true, all logs will be displayed.
+
Defined in packages/generator-common/dist/options.d.ts:138
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html
index a549cc6626..4855140619 100644
--- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html
+++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html
@@ -1,5 +1,5 @@
-AllDestinations | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+AllDestinations | SAP Cloud SDK for JavaScript - v3.0.0
Delete EVERYTHING in the specified output directory before generating code.
-
-
OptionalgenerateSdkMetadata
-
generateSdkMetadata?:boolean
-
Hidden option only for internal usage - generate metadata for API hub integration.
-
-
+
Defined in packages/generator-common/dist/options.d.ts:111
+
Optionalinclude
include?:string
Include files matching the given glob into the root of each generated client directory.
-
-
inputDir
-
inputDir:PathLike
-
This directory will be recursively searched for .edmx/.xml files.
+
Defined in packages/generator-common/dist/options.d.ts:115
+
+
input
+
input:string
+
Specify the path to the directory or file containing the service definition(s) to generate clients for.
+Throws an error if the path does not exist.
+
+
+
Optionalmetadata
+
metadata?:boolean
+
Hidden option only for internal usage - generate metadata for API hub integration.
-
+
Defined in packages/generator-common/dist/options.d.ts:119
+
+
OptionaloptionsPerService
+
optionsPerService?:string
+
Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files.
+The configuration allows to set a directoryName and npmPackageName for every service, identified by the path to the original file.
+It also makes sure that names do not change between generator runs.
+If a directory is passed, a options-per-service.json file is read/created in this directory.
+
+
outputDir
-
outputDir:PathLike
+
outputDir:string
Directory to save the generated code in.
-
+
Defined in packages/generator-common/dist/options.d.ts:123
+
Optionaloverwrite
overwrite?:boolean
Exit when encountering a file that already exists.
When set to true, it will be overwritten instead.
Note, that compared to the clearOutputDir option, this will not delete outdated files.
-
+
Defined in packages/generator-common/dist/options.d.ts:133
+
OptionalpackageJson
packageJson?:boolean
Generate a package.json file, specifying dependencies and scripts for compiling.
-
+
Defined in packages/generator-common/dist/options.d.ts:127
+
OptionalprettierConfig
-
prettierConfig?:PathLike
+
prettierConfig?:string
Specify the path to the prettier config. If not given a default config will be used for the generated sources.
-
+
Defined in packages/generator-common/dist/options.d.ts:158
+
Optionalreadme
readme?:boolean
Generate default README.md files in the client directories.
-
-
OptionalserviceMapping
-
serviceMapping?:PathLike
-
Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files.
-Will be generated if not existent.
-Default set to inputDir/service-mapping.json.
-
-
+
Defined in packages/generator-common/dist/options.d.ts:162
+
OptionalskipValidation
skipValidation?:boolean
Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords.
If you enable this option, conflicts are resolved by appending postfixes like '_1".
+
Defined in packages/generator-common/dist/options.d.ts:143
OptionaltranspilationProcesses
transpilationProcesses?:number
Number of node processes used for transpilation of JavaScript files.
-
+
Defined in packages/generator/dist/options/options.d.ts:13
+
Optionaltranspile
transpile?:boolean
When enabled, generates transpiled .js, .js.map, and .d.ts files.
By default, only .ts files are generated.
-
+
Defined in packages/generator-common/dist/options.d.ts:148
+
Optionaltsconfig
tsconfig?:string
Replace the default tsconfig.json by passing a path to a custom configuration.
By default, a tsconfig.json is only generated when transpilation is enabled (transpile).
If a directory is passed, a tsconfig.json file is read from this directory.
+
Defined in packages/generator-common/dist/options.d.ts:154
OptionaluseSwagger
useSwagger?:boolean
If set to true, swagger definitions (JSON) are used for generation.
-
+
Defined in packages/generator/dist/options/options.d.ts:9
+
Optionalverbose
verbose?:boolean
By default, only errors, warnings and important info logs will be displayed.
If set to true, all logs will be displayed.
+
Defined in packages/generator-common/dist/options.d.ts:138
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html
new file mode 100644
index 0000000000..101a4ddd4c
--- /dev/null
+++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html
@@ -0,0 +1,105 @@
+
+CsrfMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.0.0
+
URL used for the token fetching. Default is the resource path without parameters.
+
+
+
+
+
Settings
+
+
+
Member Visibility
+
+
Theme
+
+
+
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
+
\ No newline at end of file
diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html
index 30176cc11f..3c793a9e06 100644
--- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html
+++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html
@@ -1,5 +1,5 @@
-DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.0.0
Represents an e-mail address.
-This interface is compatible with Mail.Address of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with Mail.Address of nodemailer.
Hierarchy
Address
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:15
Represents an attachment.
-This interface is compatible with Attachment of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with Attachment of nodemailer.
Hierarchy
@@ -29,7 +28,7 @@
Hierarchy
Attachment
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:57
@@ -56,7 +55,7 @@
Optional
Optional content id for using inline images in HTML message source. Using cid sets the default contentDisposition to 'inline' and moves the attachment into a multipart/related MIME node, so use it only if you actually want to use this attachment as an embedded image.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:65
Optionalcontent
content?:string | Readable | Buffer
@@ -64,49 +63,49 @@
Optional
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:47
OptionalcontentDisposition
contentDisposition?:"attachment" | "inline"
Content disposition type of the attachment. Defaults to attachment.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:81
Encoding for the attachment transfer. Will be derived from the contentType property, if not set. Example values: quoted-printable, base64. If it is unset then base64 encoding is used for the attachment. If set to false, the previous default applies (base64 for most, 7bit for text).
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:77
OptionalcontentType
contentType?:string
Content type of the attachment. Will be derived from the filename property, if not set.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:73
Optionalencoding
encoding?:string
Encoding used to encode the content to a buffer. Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail object.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:69
Optionalfilename
filename?:string | false
Filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value to false, otherwise a filename is generated automatically.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:61
Represents the structure of an attachment.
-This interface is compatible with AttachmentLike of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with AttachmentLike of nodemailer.
Represents an envelope that contains the e-mail addresses of the sender and the recipients.
-This interface is compatible with MimeNode.Envelope of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with MimeNode.Envelope of nodemailer.
Hierarchy
Envelope
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:157
Represents configurations for sending an e-mail.
-This interface is compatible with Mail.Options of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with Mail.Options of nodemailer.
Hierarchy
MailConfig
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:95
@@ -58,98 +57,98 @@
Optional
Array of attachment objects.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:139
Represents the response from the mail server.
-This interface is compatible with SMTPTransport.SentMessageInfo of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with SMTPTransport.SentMessageInfo of nodemailer.
Hierarchy
MailResponse
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:171
@@ -49,35 +48,35 @@
Optional
Array of e-mail addresses that accepted the requests.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:179
Defined in packages/mail-client/dist/mail-client-types.d.ts:255
@@ -43,7 +43,7 @@
Optional
Option to define the strategy of sending emails. The emails will be sent in parallel when set to true, otherwise in sequential. The default value is true.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:259
Represents options for setting up the SMTP connection.
-This interface is compatible with SMTPConnection.Options of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This interface is compatible with SMTPConnection.Options of nodemailer.
Defined in packages/mail-client/dist/mail-client-types.d.ts:274
@@ -58,77 +57,77 @@
Optional
Connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plain text to cipher text.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:320
OptionalconnectionTimeout
connectionTimeout?:number
How many milliseconds to wait for the connection to establish.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:294
Optionaldebug
debug?:boolean
If set to true, then logs SMTP traffic and message content, otherwise logs only transaction events.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:306
OptionalgreetingTimeout
greetingTimeout?:number
How many milliseconds to wait for the greeting after connection is established.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:298
OptionalignoreTLS
ignoreTLS?:boolean
Turns off STARTTLS support if true.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:282
OptionalopportunisticTLS
opportunisticTLS?:boolean
Tries to use STARTTLS and continues normally if it fails.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:290
Optionalproxy
proxy?:string
A proxy URL used for connecting the SMTP server. This value will be forwarded to the underlying nodemailer lib, so it handles the proxy job for the SDK.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:324
OptionalrequireTLS
requireTLS?:boolean
Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:286
Optionalsecure
secure?:boolean
Defines if the connection should use SSL (if true) or not (if false).
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:278
Optionalsocket
socket?:Socket
Initialized socket to use instead of creating a new one.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:316
OptionalsocketTimeout
socketTimeout?:number
How many milliseconds of inactivity to allow.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:302
Optionaltls
tls?:ConnectionOptions
@@ -138,7 +137,7 @@
Example
{
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:312
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html
index 4f2cef5d76..337ea9f18e 100644
--- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html
+++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html
@@ -1,5 +1,5 @@
-ResilienceOptions | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+ResilienceOptions | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/modules/generatorcommon_src.html b/knowledge-base/api-reference/modules/generatorcommon_src.html
new file mode 100644
index 0000000000..f6c296cb23
--- /dev/null
+++ b/knowledge-base/api-reference/modules/generatorcommon_src.html
@@ -0,0 +1,68 @@
+
+generator-common/src | SAP Cloud SDK for JavaScript - v3.0.0
+
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
+
\ No newline at end of file
diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html
index d751c284a5..bd1c37f8e4 100644
--- a/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html
+++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html
@@ -1,5 +1,5 @@
-@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html
index ae57c6a704..09e1c2234b 100644
--- a/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html
+++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html
@@ -1,5 +1,5 @@
-@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
+
\ No newline at end of file
diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html
index d7306700ce..1bd0851acd 100644
--- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html
+++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html
@@ -1,5 +1,5 @@
-HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.0.0
Headers:{ Â Â Â Â [key: string]: string | string[] | { Â Â Â Â Â Â Â Â prepared: boolean; Â Â Â Â Â Â Â Â value: string; Â Â Â Â }; } | { Â Â Â Â key: string; Â Â Â Â value: string; }[]
Represents an object or array of additional header fields.
Prepared header values that are not folded or encoded by Nodemailer.
-This type is compatible with Headers of nodemailer.
- This API is experimental and might change in newer versions. Use with caution.
+This type is compatible with Headers of nodemailer.
+
Defined in packages/mail-client/dist/mail-client-types.d.ts:30
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
\ No newline at end of file
diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html
index 834365bd48..39e188fc64 100644
--- a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html
+++ b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html
@@ -1,5 +1,5 @@
-Middleware | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+Middleware | SAP Cloud SDK for JavaScript - v3.0.0
Middleware type - This function takes some initial function and returns a function.
-The input is the MiddlewareIn containing the initial function and some context information e.g. axios request and the request context.
+The input containing the initial function and some context information e.g. axios request and the request context.
It returns a new functions with some additional feature e.g. timeout.
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
-
\ No newline at end of file
diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html b/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html
index 8a944243b9..3dc25977b8 100644
--- a/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html
+++ b/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html
@@ -1,5 +1,5 @@
-LogLevel | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+LogLevel | SAP Cloud SDK for JavaScript - v3.0.0
Copyright â’¸ 2023 SAP SE or an SAP affiliate company. All rights reserved.
-
\ No newline at end of file
diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html
index 69fdcb032b..19e947239d 100644
--- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html
+++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html
@@ -1,5 +1,5 @@
-cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.0.0-alpha.0
+cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.0.0
Set middleware for requests towards the target system given in the destination.
@@ -330,13 +330,24 @@Returns
The request builder itself, to facilitate method chaining.
Parametersmiddlewares: HttpMiddleware[]
+middlewares: HttpMiddleware | HttpMiddleware[]
Middlewares to be applied to the executeHttpRequest().