refine the wording

Azure · Dec 13, 2024 · d325525 · d325525
1 parent fb322c4
commit d325525
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 32 deletions.
diff --git a/packages/typespec-client-generator-core/README.md b/packages/typespec-client-generator-core/README.md
@@ -446,11 +446,11 @@ model Bar {}
 #### `@isApiVersion`
 
 Use to override default assumptions on whether a parameter is an api-version parameter or not.
-By default, we do matches with the `api-version` string in the parameter name. Since api versions are
-a client parameter, we will also elevate this parameter up onto the client
+By default, we do matches with the `api-version` or `apiversion` string in the parameter name. Since api versions are
+a client parameter, we will also elevate this parameter up onto the client.
 
 ```typespec
-@Azure.ClientGenerator.Core.isApiVersion(value: valueof boolean, scope?: valueof string)
+@Azure.ClientGenerator.Core.isApiVersion(value?: valueof boolean, scope?: valueof string)
 ```
 
 ##### Target

diff --git a/packages/typespec-client-generator-core/generated-defs/Azure.ClientGenerator.Core.ts b/packages/typespec-client-generator-core/generated-defs/Azure.ClientGenerator.Core.ts
@@ -535,8 +535,8 @@ export type ClientNamespaceDecorator = (
 
 /**
  * Use to override default assumptions on whether a parameter is an api-version parameter or not.
- * By default, we do matches with the `api-version` string in the parameter name. Since api versions are
- * a client parameter, we will also elevate this parameter up onto the client
+ * By default, we do matches with the `api-version` or `apiversion` string in the parameter name. Since api versions are
+ * a client parameter, we will also elevate this parameter up onto the client.
  *
  * @example
  * ```typespec

diff --git a/packages/typespec-client-generator-core/lib/decorators.tsp b/packages/typespec-client-generator-core/lib/decorators.tsp
@@ -516,8 +516,8 @@ extern dec clientNamespace(
 
 /**
  * Use to override default assumptions on whether a parameter is an api-version parameter or not.
- * By default, we do matches with the `api-version` string in the parameter name. Since api versions are
- * a client parameter, we will also elevate this parameter up onto the client
+ * By default, we do matches with the `api-version` or `apiversion` string in the parameter name. Since api versions are
+ * a client parameter, we will also elevate this parameter up onto the client.
  *
  * @example
  * ```typespec

diff --git a/packages/typespec-client-generator-core/src/decorators.ts b/packages/typespec-client-generator-core/src/decorators.ts
@@ -1014,13 +1014,13 @@ export function getClientInitialization(
 
 const paramAliasKey = createStateSymbol("paramAlias");
 
-export const paramAliasDecorator: ParamAliasDecorator = (
+export const $paramAlias: ParamAliasDecorator = (
   context: DecoratorContext,
   original: ModelProperty,
   paramAlias: string,
   scope?: LanguageScopes,
 ) => {
-  setScopedDecoratorData(context, paramAliasDecorator, paramAliasKey, original, paramAlias, scope);
+  setScopedDecoratorData(context, $paramAlias, paramAliasKey, original, paramAlias, scope);
 };
 
 export function getParamAlias(context: TCGCContext, original: ModelProperty): string | undefined {
@@ -1029,26 +1029,16 @@ export function getParamAlias(context: TCGCContext, original: ModelProperty): st
 
 const isApiVersionKey = createStateSymbol("isApiVersion");
 
-export const isApiVersionDecorator: IsApiVersionDecorator = (
+export const $isApiVersion: IsApiVersionDecorator = (
   context: DecoratorContext,
   param: ModelProperty,
   value?: boolean,
   scope?: LanguageScopes,
 ) => {
-  setScopedDecoratorData(
-    context,
-    isApiVersionDecorator,
-    isApiVersionKey,
-    param,
-    value ?? true,
-    scope,
-  );
+  setScopedDecoratorData(context, $isApiVersion, isApiVersionKey, param, value ?? true, scope);
 };
 
-export function getIsApiVersionDecorator(
-  context: TCGCContext,
-  param: ModelProperty,
-): boolean | undefined {
+export function getIsApiVersion(context: TCGCContext, param: ModelProperty): boolean | undefined {
   return getScopedDecoratorData(context, isApiVersionKey, param);
 }
 

diff --git a/packages/typespec-client-generator-core/src/public-utils.ts b/packages/typespec-client-generator-core/src/public-utils.ts
@@ -25,7 +25,7 @@ import { pascalCase } from "change-case";
 import pluralize from "pluralize";
 import {
   getClientNameOverride,
-  getIsApiVersionDecorator,
+  getIsApiVersion,
   listClients,
   listOperationGroups,
   listOperationsInOperationGroup,
@@ -80,7 +80,7 @@ function isModelProperty(type: any): type is ModelProperty {
  */
 export function isApiVersion(context: TCGCContext, type: { name: string }): boolean {
   if (isModelProperty(type)) {
-    const override = getIsApiVersionDecorator(context, type);
+    const override = getIsApiVersion(context, type);
     if (override !== undefined) {
       return override;
     }

diff --git a/packages/typespec-client-generator-core/src/tsp-index.ts b/packages/typespec-client-generator-core/src/tsp-index.ts
@@ -7,13 +7,13 @@ import {
   $clientNamespace,
   $convenientAPI,
   $flattenProperty,
+  $isApiVersion,
   $operationGroup,
   $override,
+  $paramAlias,
   $protocolAPI,
   $usage,
   $useSystemTextJsonConverter,
-  isApiVersionDecorator,
-  paramAliasDecorator,
 } from "./decorators.js";
 
 export { $lib } from "./lib.js";
@@ -33,8 +33,8 @@ export const $decorators = {
     override: $override,
     useSystemTextJsonConverter: $useSystemTextJsonConverter,
     clientInitialization: $clientInitialization,
-    paramAlias: paramAliasDecorator,
-    isApiVersion: isApiVersionDecorator,
+    paramAlias: $paramAlias,
+    isApiVersion: $isApiVersion,
     clientNamespace: $clientNamespace,
   } as AzureClientGeneratorCoreDecorators,
 };
diff --git a/packages/typespec-client-generator-core/test/decorators/is-api-version.test.ts b/packages/typespec-client-generator-core/test/decorators/is-api-version.test.ts
@@ -32,7 +32,8 @@ describe("@isApiVersion", () => {
       ok(apiVersionParam);
       strictEqual(apiVersionParam.isApiVersionParam, true);
     });
-    it("overidden api version param defaults to latest api version", async () => {
+
+    it("override api version param defaults to latest api version", async () => {
       await runner.compile(`
         @service({
           title: "Contoso Widget Manager",
@@ -70,6 +71,7 @@ describe("@isApiVersion", () => {
       strictEqual(apiVersionOpParam.isApiVersionParam, true);
       strictEqual(apiVersionOpParam.correspondingMethodParams[0], apiVersionClientParam);
     });
+
     it("override parameter to not be api version", async () => {
       await runner.compile(`
         @service({})

diff --git a/...tent/docs/docs/libraries/typespec-client-generator-core/reference/decorators.md b/...tent/docs/docs/libraries/typespec-client-generator-core/reference/decorators.md
@@ -368,11 +368,11 @@ model Bar {}
 ### `@isApiVersion` {#@Azure.ClientGenerator.Core.isApiVersion}
 
 Use to override default assumptions on whether a parameter is an api-version parameter or not.
-By default, we do matches with the `api-version` string in the parameter name. Since api versions are
-a client parameter, we will also elevate this parameter up onto the client
+By default, we do matches with the `api-version` or `apiversion` string in the parameter name. Since api versions are
+a client parameter, we will also elevate this parameter up onto the client.
 
 ```typespec
-@Azure.ClientGenerator.Core.isApiVersion(value: valueof boolean, scope?: valueof string)
+@Azure.ClientGenerator.Core.isApiVersion(value?: valueof boolean, scope?: valueof string)
 ```
 
 #### Target