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.

Sign up for GitHub

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

Refine comments for renaming part in client generation #2241

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Refine comments for renaming part in client generation #2241

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a45f25c
Add imports and usings infor to resolve compile issues
MaryGao Feb 21, 2025
5c4bb20
Update the typescript comments
MaryGao Feb 21, 2025
2656949
Update the specs
MaryGao Feb 21, 2025
97dd276
Remove the import parts
MaryGao Feb 21, 2025
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
31 changes: 29 additions & 2 deletions website/src/content/docs/docs/howtos/Generate client libraries/04renaming.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,34 @@ By default, any language code generator will assume the TYPESPEC name is the cli
<ClientTabs>

```typespec title=main.tsp
import "@typespec/http";
import "@typespec/rest";
import "@typespec/versioning";
import "@azure-tools/typespec-azure-core";

using TypeSpec.Http;
using TypeSpec.Rest;
using Azure.Core;
using TypeSpec.Versioning;

@service({
title: "Pet Store Client",
})
@server(
"{endpoint}/widget",
"Pet Store APIs",
{
endpoint: string,
}
)
@versioned(PetStoreNamespace.Versions)
namespace PetStoreNamespace;

enum Versions {
@useDependency(Azure.Core.Versions.v1_0_Preview_2)
`2022-08-30`,
}

/** This is the input I need */
@resource("input")
model InputModel {
Expand Down Expand Up @@ -66,6 +92,7 @@ namespace PetStoreNamespace
```

```typescript
// Here is the generated code for TypeScript RLC
interface InputModel {
name: string;
}
Expand Down Expand Up @@ -147,7 +174,7 @@ namespace PetStoreNamespace
```

```typescript
// Typescript do not change behavior based on protocolAPI or convenientAPI
// TypeScript RLC won't change behavior based on protocolAPI or convenientAPI
```

```java
Expand Down Expand Up @@ -211,7 +238,7 @@ namespace PetStoreNamespace
```

```typescript
// Typescript do not change behavior based on protocolAPI or convenientAPI
// TypeScript RLC won't change behavior based on protocolAPI or convenientAPI
```

```java
Expand Down
Loading