From cb85509110644a76407ffb0c06c02ed1b196fdf2 Mon Sep 17 00:00:00 2001 From: catalinaperalta Date: Thu, 23 Jan 2025 17:49:15 -0800 Subject: [PATCH 1/2] update docs --- tools/tsp-client/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tools/tsp-client/README.md b/tools/tsp-client/README.md index 238da377ab6..89a85dba7d3 100644 --- a/tools/tsp-client/README.md +++ b/tools/tsp-client/README.md @@ -65,7 +65,15 @@ Sort an existing swagger specification to be the same content order with TypeSpe ### generate-config-files -Generate the `emitter-package.json` and `emitter-package-lock.json` used for tsp-client commands under the eng/ directory of your current repository. Run this command from the target repository and pass in the path to the package.json file of the emitter you want to use generate the configuration files. +This command generates the default configuration files used by tsp-client. Run this command to generate the `emitter-package.json` and `emitter-package-lock.json` under the **eng/** directory of your current repository. + +**Required: Use the `--package-json` flag to specify the path to the package.json file of the emitter you will use to generate client libraries.** + +Example: + +``` +azure-sdk-for-python> tsp-client generate-config-files --package-json ..\\package.json +``` ### generate-lock-file From 2c4cb54b69feeac073cef81a6e8fcc698b6a73cb Mon Sep 17 00:00:00 2001 From: catalinaperalta Date: Thu, 23 Jan 2025 17:51:32 -0800 Subject: [PATCH 2/2] update example --- tools/tsp-client/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/tsp-client/README.md b/tools/tsp-client/README.md index 89a85dba7d3..0a512ee9b65 100644 --- a/tools/tsp-client/README.md +++ b/tools/tsp-client/README.md @@ -72,7 +72,7 @@ This command generates the default configuration files used by tsp-client. Run t Example: ``` -azure-sdk-for-python> tsp-client generate-config-files --package-json ..\\package.json +azure-sdk-for-python> tsp-client generate-config-files --package-json \package.json ``` ### generate-lock-file