From 139d39e40ac80e727c6c51995956362472fa3e14 Mon Sep 17 00:00:00 2001 From: Lubos Date: Wed, 25 Mar 2026 01:21:53 +0100 Subject: [PATCH] chore: update comments for ie --- docs/openapi-ts/integrations.md | 2 +- packages/custom-client/src/utils.ts | 2 +- packages/json-schema-ref-parser/src/bundle.ts | 8 ++++---- packages/json-schema-ref-parser/src/dereference.ts | 2 +- .../openapi-ts-tests/main/test/custom/client/utils.ts | 2 +- .../src/plugins/@hey-api/client-angular/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-axios/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-core/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-fetch/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-next/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-nuxt/bundle/utils.ts | 2 +- .../src/plugins/@hey-api/client-ofetch/bundle/utils.ts | 2 +- packages/shared/src/getSpec.ts | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/openapi-ts/integrations.md b/docs/openapi-ts/integrations.md index 4c945cbf9..dc21c60ce 100644 --- a/docs/openapi-ts/integrations.md +++ b/docs/openapi-ts/integrations.md @@ -87,7 +87,7 @@ Personal API keys can't be used to upload specifications. #### `GITHUB_TOKEN` This variable will be available inside your workflow by default. It's used to -fetch information about your repository, i.e. default branch. +fetch information about your repository, i.e., default branch. ## Generate Clients diff --git a/packages/custom-client/src/utils.ts b/packages/custom-client/src/utils.ts index 946ae5e90..143e3aa77 100644 --- a/packages/custom-client/src/utils.ts +++ b/packages/custom-client/src/utils.ts @@ -300,7 +300,7 @@ export const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, diff --git a/packages/json-schema-ref-parser/src/bundle.ts b/packages/json-schema-ref-parser/src/bundle.ts index cb9340ff9..8b7da1dec 100644 --- a/packages/json-schema-ref-parser/src/bundle.ts +++ b/packages/json-schema-ref-parser/src/bundle.ts @@ -92,7 +92,7 @@ const getContainerTypeFromPath = ( }; /** - * Inventories the given JSON Reference (i.e. records detailed information about it so we can + * Inventories the given JSON Reference (i.e., records detailed information about it so we can * optimize all $refs in the schema), and then crawls the resolved value. */ const inventory$Ref = ({ @@ -214,9 +214,9 @@ const inventory$Ref = ({ const newEntry: InventoryEntry = { $ref, // The JSON Reference (e.g., {$ref: string}) - circular: pointer.circular, // Is this $ref pointer DIRECTLY circular? (i.e. it references itself) + circular: pointer.circular, // Is this $ref pointer DIRECTLY circular? (i.e., it references itself) depth, // How far from the JSON Schema root is this $ref pointer? - extended, // Does this $ref extend its resolved value? (i.e. it has extra properties, in addition to "$ref") + extended, // Does this $ref extend its resolved value? (i.e., it has extra properties, in addition to "$ref") external, // Does this $ref pointer point to a file other than the main JSON Schema file? file, // The file that the $ref pointer resolves to hash, // The hash within `file` that the $ref pointer resolves to @@ -570,7 +570,7 @@ function remap(parser: $RefParser, inventory: Array) { } // Keep internal refs internal. However, if the $ref extends the resolved value - // (i.e. it has additional properties in addition to "$ref"), then we must + // (i.e., it has additional properties in addition to "$ref"), then we must // preserve the original $ref rather than rewriting it to the resolved hash. if (!entry.external) { if (!entry.extended && entry.$ref && typeof entry.$ref === 'object') { diff --git a/packages/json-schema-ref-parser/src/dereference.ts b/packages/json-schema-ref-parser/src/dereference.ts index 862954795..4d97209d8 100644 --- a/packages/json-schema-ref-parser/src/dereference.ts +++ b/packages/json-schema-ref-parser/src/dereference.ts @@ -226,7 +226,7 @@ function dereference$Ref( } if (directCircular) { - // The pointer is a DIRECT circular reference (i.e. it references itself). + // The pointer is a DIRECT circular reference (i.e., it references itself). // So replace the $ref path with the absolute path from the JSON Schema root dereferencedValue.$ref = pathFromRoot; } diff --git a/packages/openapi-ts-tests/main/test/custom/client/utils.ts b/packages/openapi-ts-tests/main/test/custom/client/utils.ts index a25379278..bef25089f 100644 --- a/packages/openapi-ts-tests/main/test/custom/client/utils.ts +++ b/packages/openapi-ts-tests/main/test/custom/client/utils.ts @@ -289,7 +289,7 @@ export const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/utils.ts index c08c19eea..4b6a3c5c9 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/utils.ts @@ -296,7 +296,7 @@ export const mergeHeaders = ( mergedHeaders = mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders = mergedHeaders.set( key, diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/utils.ts index 9749f7ff5..44f05c25a 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-axios/bundle/utils.ts @@ -190,7 +190,7 @@ export const mergeHeaders = ( mergedHeaders[key] = [...(mergedHeaders[key] ?? []), v as string]; } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders[key] = typeof value === 'object' ? JSON.stringify(value) : (value as string); } diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-core/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-core/bundle/utils.ts index 0ce3c0728..817aa778f 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-core/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-core/bundle/utils.ts @@ -124,7 +124,7 @@ export function getValidRequestBody(options: { return hasSerializedBody ? options.serializedBody : null; } - // not all clients implement a serializedBody property (i.e. client-axios) + // not all clients implement a serializedBody property (i.e., client-axios) return options.body !== '' ? options.body : null; } diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/utils.ts index e7141953a..e55d07223 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/utils.ts @@ -202,7 +202,7 @@ export const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/utils.ts index 5a27b543b..50ff580f7 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/utils.ts @@ -311,7 +311,7 @@ export const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/bundle/utils.ts index 72d10b70e..34061c616 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/bundle/utils.ts @@ -286,7 +286,7 @@ export const mergeHeaders = ( } } else if (value !== undefined) { const v = unwrapRefs(value); - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set(key, typeof v === 'object' ? JSON.stringify(v) : (v as string)); } diff --git a/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/bundle/utils.ts b/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/bundle/utils.ts index eca06ab1a..7d177454f 100644 --- a/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/bundle/utils.ts +++ b/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/bundle/utils.ts @@ -233,7 +233,7 @@ export const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, diff --git a/packages/shared/src/getSpec.ts b/packages/shared/src/getSpec.ts index c9c251d9c..059aae021 100644 --- a/packages/shared/src/getSpec.ts +++ b/packages/shared/src/getSpec.ts @@ -35,7 +35,7 @@ const mergeHeaders = ( mergedHeaders.append(key, v as string); } } else if (value !== undefined) { - // assume object headers are meant to be JSON stringified, i.e. their + // assume object headers are meant to be JSON stringified, i.e., their // content value in OpenAPI specification is 'application/json' mergedHeaders.set( key, -- 2.51.2