Merge pull request #315 from hey-api/fix/escape-description-zendesk

fix(parser): escape backticks in strings starting with backtick
hey-api · Apr 9, 2024 · 80f192e · 80f192e
2 parents 58a1dcb + c8e0718
commit 80f192e
Show file tree

Hide file tree

Showing 20 changed files with 82 additions and 18 deletions.
diff --git a/.changeset/violet-beans-push.md b/.changeset/violet-beans-push.md
@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix: escape backticks in strings starting with backtick
diff --git a/packages/openapi-ts/src/compiler/utils.ts b/packages/openapi-ts/src/compiler/utils.ts
@@ -65,11 +65,11 @@ export const ots = {
         if (unescape) {
             value = unescapeName(value);
         }
-        if (
-            (value.includes('\n') || (value.includes("'") && value.includes('"'))) &&
-            !value.startsWith('`') &&
-            !value.endsWith('`')
-        ) {
+        const hasBothQuotes = value.includes("'") && value.includes('"');
+        const hasNewlines = value.includes('\n');
+        const hasUnescapedBackticks = value.startsWith('`');
+        const isBacktickEscaped = value.startsWith('\\`') && value.endsWith('\\`');
+        if ((hasNewlines || hasBothQuotes || hasUnescapedBackticks) && !isBacktickEscaped) {
             value = `\`${value.replace(/`/g, '\\`')}\``;
         }
         const text = encodeURIComponent(value);

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/models.ts.snap
@@ -273,6 +273,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -835,7 +840,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.ts.snap
@@ -323,6 +323,11 @@ export const $ModelWithString = {
     },
 } as const;
 
+export const $ModelFromZendesk = {
+    description: `\`Comment\` or \`VoiceComment\`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)`,
+    type: 'string',
+} as const;
+
 export const $ModelWithNullableString = {
     description: 'This is a model with one string property',
     type: 'object',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3/services.ts.snap
@@ -57,7 +57,7 @@ export class DefaultService {
 
 export class SimpleService {
     /**
-     * @returns ModelWithString Success
+     * @returns ModelFromZendesk Success
      * @throws ApiError
      */
     public static apiVVersionOdataControllerCount(): CancelablePromise<

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.ts.snap
@@ -223,6 +223,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -732,7 +737,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.ts.snap
@@ -323,6 +323,11 @@ export const $ModelWithString = {
     },
 } as const;
 
+export const $ModelFromZendesk = {
+    description: `\`Comment\` or \`VoiceComment\`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)`,
+    type: 'string',
+} as const;
+
 export const $ModelWithNullableString = {
     description: 'This is a model with one string property',
     type: 'object',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.ts.snap
@@ -69,7 +69,7 @@ export class SimpleService {
     constructor(public readonly http: HttpClient) {}
 
     /**
-     * @returns ModelWithString Success
+     * @returns ModelFromZendesk Success
      * @throws ApiError
      */
     public apiVVersionOdataControllerCount(): Observable<SimpleData['responses']['ApiVversionOdataControllerCount']> {

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.ts.snap
@@ -273,6 +273,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -835,7 +840,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.ts.snap
@@ -60,7 +60,7 @@ export class SimpleService {
     constructor(public readonly httpRequest: BaseHttpRequest) {}
 
     /**
-     * @returns ModelWithString Success
+     * @returns ModelFromZendesk Success
      * @throws ApiError
      */
     public apiVVersionOdataControllerCount(): CancelablePromise<

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.ts.snap
@@ -28,7 +28,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.ts.snap
@@ -323,6 +323,11 @@ export const $ModelWithString = {
     },
 } as const;
 
+export const $ModelFromZendesk = {
+    description: `\`Comment\` or \`VoiceComment\`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)`,
+    type: 'string',
+} as const;
+
 export const $ModelWithNullableString = {
     description: 'This is a model with one string property',
     type: 'object',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.ts.snap
@@ -259,6 +259,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -777,7 +782,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.ts.snap
@@ -323,6 +323,11 @@ export const $ModelWithString = {
     },
 } as const;
 
+export const $ModelFromZendesk = {
+    description: `\`Comment\` or \`VoiceComment\`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)`,
+    type: 'string',
+} as const;
+
 export const $ModelWithNullableString = {
     description: 'This is a model with one string property',
     type: 'object',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/services.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/services.ts.snap
@@ -57,7 +57,7 @@ export class DefaultService {
 
 export class SimpleService {
     /**
-     * @returns ModelWithString Success
+     * @returns ModelFromZendesk Success
      * @throws ApiError
      */
     public static apiVVersionOdataControllerCount(): CancelablePromise<

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/models.ts.snap
@@ -223,6 +223,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -734,7 +739,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/schemas.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/schemas.ts.snap
@@ -323,6 +323,11 @@ export const $ModelWithString = {
     },
 } as const;
 
+export const $ModelFromZendesk = {
+    description: `\`Comment\` or \`VoiceComment\`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)`,
+    type: 'string',
+} as const;
+
 export const $ModelWithNullableString = {
     description: 'This is a model with one string property',
     type: 'object',

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/services.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_experimental/services.ts.snap
@@ -57,7 +57,7 @@ export class DefaultService {
 
 export class SimpleService {
     /**
-     * @returns ModelWithString Success
+     * @returns ModelFromZendesk Success
      * @throws ApiError
      */
     public static apiVVersionOdataControllerCount(): CancelablePromise<

diff --git a/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/models.ts.snap b/packages/openapi-ts/test/__snapshots__/test/generated/v3_models/models.ts.snap
@@ -223,6 +223,11 @@ export type ModelWithString = {
     prop?: string;
 };
 
+/**
+ * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)
+ */
+export type ModelFromZendesk = string;
+
 /**
  * This is a model with one string property
  */
@@ -732,7 +737,7 @@ export type DefaultData = {
 
 export type SimpleData = {
     responses: {
-        ApiVversionOdataControllerCount: ModelWithString;
+        ApiVversionOdataControllerCount: ModelFromZendesk;
         GetCallWithoutParametersAndResponse: void;
         PutCallWithoutParametersAndResponse: void;
         PostCallWithoutParametersAndResponse: void;

diff --git a/packages/openapi-ts/test/spec/v3.json b/packages/openapi-ts/test/spec/v3.json
@@ -60,7 +60,7 @@
                         "content": {
                             "application/json; type=collection": {
                                 "schema": {
-                                    "$ref": "#/components/schemas/ModelWithString"
+                                    "$ref": "#/components/schemas/ModelFromZendesk"
                                 }
                             }
                         }
@@ -2048,6 +2048,10 @@
                     }
                 }
             },
+            "ModelFromZendesk": {
+                "description": "`Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets)",
+                "type": "string"
+            },
             "ModelWithNullableString": {
                 "description": "This is a model with one string property",
                 "type": "object",