Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update document for DPG sdk-automation #30457

Merged
merged 3 commits into from
Sep 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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`.