Skip to content

Commit

Permalink
update document for DPG sdk-automation (Azure#30457)
Browse files Browse the repository at this point in the history
* update document for DPG sdk-automation

* update

---------

Co-authored-by: Pan Shao <pashao@microsoft.com>
  • Loading branch information
2 people authored and digvijaymali94 committed Dec 17, 2024
1 parent 73aa742 commit 00d96b2
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions documentation/onboard-dpg-in-sdkautomation/.net/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
# 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.

- `<ServiceName>`: The RP name, which is usually same as folder name in swagger.
- `<NameSpace>`: Python package name.
- `<Title>`: 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. It should be several parts concatenated with `.` and all the paerts should be pascal case.
- `flavor`: Always `azure` for Azure SDK.
- `namespace`: Should be the same as `package-dir`.

0 comments on commit 00d96b2

Please sign in to comment.