From 0c80ebf12e53cc3e698b58368c1c986a22f2b702 Mon Sep 17 00:00:00 2001 From: Pan Shao Date: Fri, 6 Sep 2024 16:06:51 +0800 Subject: [PATCH 1/2] update document for DPG sdk-automation --- .../.net/README.md | 27 +++++++------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/documentation/onboard-dpg-in-sdkautomation/.net/README.md b/documentation/onboard-dpg-in-sdkautomation/.net/README.md index c4d4ec97060b..cd46f6166aba 100644 --- a/documentation/onboard-dpg-in-sdkautomation/.net/README.md +++ b/documentation/onboard-dpg-in-sdkautomation/.net/README.md @@ -1,22 +1,13 @@ -# Add Autorest Configuration of .Net SDK +# Add TypeSpec Configuration of .Net SDK -## Parameter Description +Please copy the following configuration into `tspconfig.yaml` in your spec folder and replace `package-dir` and `namespace` to your own values. -- ``: The RP name, which is usually same as folder name in swagger. -- ``: Python package name. -- ``: SDK Client Name. It's optional if there is a title defined in spec readme.md file. - -## Autorest Configuration -Please copy the following configuration into spec PR comment. -~~~ -# azure-sdk-for-net-track2 ``` yaml -title: <Title> -output-folder: sdk/<ServiceName>/<NameSpace> -require: - - specification/<RPName>/data-plane/readme.md + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Vision.Face" + flavor: azure + namespace: "{package-dir}" ``` -~~~ -- `title`: If it's already defined in spec readme.md, you don't need to define it here again. (By default, there is no `title` defined in spec readme.md in multi client scenario.) -- `output-folder`: The relative path of destination to generate SDK. -- `require`: The item of the value is the relative path of spec readme.md file. +- `package-dir`: Name of your package directory. +- `flavor`: Always `azure` for Azure SDK. +- `namespace`: Namespace of your generated SDK. From 23ff5652d083cc0150a700063e292154f5f0e924 Mon Sep 17 00:00:00 2001 From: pshao25 <97225342+pshao25@users.noreply.github.com> Date: Thu, 26 Sep 2024 13:36:19 +0800 Subject: [PATCH 2/2] update --- documentation/onboard-dpg-in-sdkautomation/.net/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/onboard-dpg-in-sdkautomation/.net/README.md b/documentation/onboard-dpg-in-sdkautomation/.net/README.md index cd46f6166aba..3c071bd90db4 100644 --- a/documentation/onboard-dpg-in-sdkautomation/.net/README.md +++ b/documentation/onboard-dpg-in-sdkautomation/.net/README.md @@ -8,6 +8,7 @@ Please copy the following configuration into `tspconfig.yaml` in your spec folde flavor: azure namespace: "{package-dir}" ``` -- `package-dir`: Name of your package directory. + +- `package-dir`: Name of your package directory. It should be several parts concatenated with `.` and all the paerts should be pascal case. - `flavor`: Always `azure` for Azure SDK. -- `namespace`: Namespace of your generated SDK. +- `namespace`: Should be the same as `package-dir`.