Update folder name for canonical swagger (#968)

ISSUE: since the canonical swagger file version is "canonical", based on current logic, the swagger file folder name is "stable", which should be "canonical". --------- Co-authored-by: Ding <[email protected]>
Azure · Jun 7, 2024 · 42e2912 · 42e2912
1 parent d179b2a
commit 42e2912
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/.chronus/changes/update_canonical_swagger_folder_name-2024-6-6-11-44-3.md b/.chronus/changes/update_canonical_swagger_folder_name-2024-6-6-11-44-3.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-autorest-canonical"
+---
+
+update the canonical swagger file folder name
diff --git a/docs/emitters/typespec-autorest-canonical/reference/emitter.md b/docs/emitters/typespec-autorest-canonical/reference/emitter.md
@@ -33,7 +33,7 @@ Output file will interpolate the following values:
 - service-name: Name of the service if multiple
 - azure-resource-provider-folder: Value of the azure-resource-provider-folder option
 
-Default: `{azure-resource-provider-folder}/{service-name}/{version}/openapi.json`
+Default: `{azure-resource-provider-folder}/{service-name}/canonical/openapi.json`
 
 Example: Single service
 

diff --git a/eng/feeds/arm-canonical/tspconfig.yaml b/eng/feeds/arm-canonical/tspconfig.yaml
@@ -11,7 +11,7 @@ options:
   '@azure-tools/typespec-autorest-canonical':
     emitter-output-dir: "{project-root}/.."
     azure-resource-provider-folder: "resource-manager"
-    output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json"
+    output-file: "{azure-resource-provider-folder}/{service-name}/canonical/openapi.json"
 linter:
   extends:
     - "@azure-tools/typespec-azure-rulesets/resource-manager"
diff --git a/packages/typespec-autorest-canonical/README.md b/packages/typespec-autorest-canonical/README.md
@@ -37,7 +37,7 @@ Output file will interpolate the following values:
 - service-name: Name of the service if multiple
 - azure-resource-provider-folder: Value of the azure-resource-provider-folder option
 
-Default: `{azure-resource-provider-folder}/{service-name}/{version}/openapi.json`
+Default: `{azure-resource-provider-folder}/{service-name}/canonical/openapi.json`
 
 Example: Single service
 

diff --git a/packages/typespec-autorest-canonical/src/emitter.ts b/packages/typespec-autorest-canonical/src/emitter.ts
@@ -134,8 +134,7 @@ async function emitAllServices(
 function resolveOutputFile(
   service: Service,
   multipleServices: boolean,
-  options: ResolvedAutorestCanonicalEmitterOptions,
-  version?: string
+  options: ResolvedAutorestCanonicalEmitterOptions
 ): string {
   const azureResourceProviderFolder = options.azureResourceProviderFolder;
   const interpolated = interpolatePath(options.outputFile, {
@@ -144,12 +143,6 @@ function resolveOutputFile(
       multipleServices || azureResourceProviderFolder
         ? getNamespaceFullName(service.type)
         : undefined,
-    "version-status": azureResourceProviderFolder
-      ? version?.includes("preview")
-        ? "preview"
-        : "stable"
-      : undefined,
-    version,
   });
 
   return resolvePath(options.outputDir, interpolated);

diff --git a/packages/typespec-autorest-canonical/src/lib.ts b/packages/typespec-autorest-canonical/src/lib.ts
@@ -8,7 +8,7 @@ export interface AutorestCanonicalEmitterOptions {
    *  - version: Version of the service if multiple
    *  - azure-resource-provider-folder: Value of the azure-resource-provider-folder option
    *
-   * @default `{azure-resource-provider-folder}/{service-name}/{version}/openapi.json`
+   * @default `{azure-resource-provider-folder}/{service-name}/canonical/openapi.json`
    *
    *
    * @example Single service no versioning
@@ -68,7 +68,7 @@ const EmitterOptionsSchema: JSONSchemaType<AutorestCanonicalEmitterOptions> = {
         " - service-name: Name of the service if multiple",
         " - azure-resource-provider-folder: Value of the azure-resource-provider-folder option",
         "",
-        "Default: `{azure-resource-provider-folder}/{service-name}/{version}/openapi.json`",
+        "Default: `{azure-resource-provider-folder}/{service-name}/canonical/openapi.json`",
         "",
         "",
         "Example: Single service",