[tcgc] make endpoint overridable

[iscai-msft]

fixes #1153

[azure-sdk]

All changed packages have been documented.

• ✅ @azure-tools/typespec-client-generator-core

Show changes

@azure-tools/typespec-client-generator-core - feature ✏️

Make literal endpoints overridable

[azure-sdk]

You can try these changes at https://cadlplayground.z22.web.core.windows.net/typespec-azure/prs/1155/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/typespec-azure/prs/1155/

[weidongxu-microsoft]

LGTM

[iscai-msft]

For this PR, I'm going to hold on merging it before this release because there's still open discussion about what the best way to do this is. In the meantime, I want to confirm that no language is blocked right now, correct? It's just that emitters are having to hardcode information about ARM.

[haolingdong-msft]

For this PR, I'm going to hold on merging it before this release because there's still open discussion about what the best way to do this is. In the meantime, I want to confirm that no language is blocked right now, correct? It's just that emitters are having to hardcode information about ARM.

Hi @iscai-msft, I'm afraid it blocks Java adopting TCGC sdkpackage, I guess it also blocks other languages, as it will impact all management-plane generated SDKs, it causes public API breaking change. So if TCGC will not do this and we would like to adopt TCGC sdkpackage, each language emitter will do their own handling.

API change if we do not make endpoint overridable.

[iscai-msft]

@haolingdong-msft can java do their own handling for this release? I would use this code snippet:

function serializeClient(context: SdkContext, client: SdkClientType) {
  ...
  for (param of client.initialization.parameters) {
    if (param.kind === "endpoint" && context.arm) {
      param.clientDefaultValue = param.serverUrl;
      param.serverUrl = "{baseUrl}";
      param.templateArguments = [{
          "baseUrl",
          isGeneratedName: true,
          description: "Service host",
          kind: "path",
          onClient: true,
          urlEncode: false,
          optional: false,
          serializedName: "baseUrl",
          correspondingMethodParams: [],
          type: {
            kind: "string",
            encode: "string",
            decorators: [],
          },
          isApiVersionParam: false,
          apiVersions: context.__tspTypeToApiVersions.get(client.type)!,
          crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, client.service)}.baseUrl`,
          decorators: [],
        },
      ]
    }
  }
}

function mainFunc(context: SdkContext) {
  for (const client of sdkPackage.clients) {
    serializeClient(context, client);
  }
}

We just want to make sure everyone's on the same page before committing this to tcgc. Agree that this isn't very nice code, but with this it shouldn't be blocking

[haolingdong-msft]

templateArguments 

It's fine, I will do the handling in Java emitter first. Please let me know the decission of this issue. Thanks

[tadelesh]

@iscai-msft is there any update for this? for typespec like follows, it seems there is no default value from current templated argument

@server(
  "{endpoint}",
  "Test server endpoint",
  {
    endpoint: string = "http://localhost:3000",
  }
)

[iscai-msft]

@iscai-msft is there any update for this? for typespec like follows, it seems there is no default value from current templated argument

@server(
  "{endpoint}",
  "Test server endpoint",
  {
    endpoint: string = "http://localhost:3000",
  }
)

that's a separate issue that i've fixed in a pr, following up on this current issue right now

[azure-sdk]

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs