Merge pull request #2793 from hey-api/copilot/fix-request-types-schema

Fix writeOnly schema properties missing from request types in nested schemas

Author: mrlubos

.changeset/nervous-eyes-pay.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": patch
+---
+
+fix(parser): writeOnly schema properties missing from request types in nested schemas

packages/openapi-ts-tests/main/test/3.1.x.test.ts

@@ -647,6 +647,22 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles read-only and write-only types',
     },
+    {
+      config: createConfig({
+        input: 'transforms-read-write-nested.yaml',
+        output: 'transforms-read-write-nested',
+        plugins: ['@hey-api/typescript'],
+      }),
+      description: 'handles write-only types in nested schemas',
+    },
+    {
+      config: createConfig({
+        input: 'transforms-read-write-response.yaml',
+        output: 'transforms-read-write-response',
+        plugins: ['@hey-api/typescript'],
+      }),
+      description: 'handles read-only types in nested response schemas',
+    },
     {
       config: createConfig({
         input: 'ref-type.json',

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transforms-read-write-nested/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type * from './types.gen';

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transforms-read-write-nested/types.gen.ts

@@ -0,0 +1,35 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type CreateItemRequest = {
+    payload: PayloadWritable;
+};
+
+export type Payload = {
+    kind: 'jpeg';
+};
+
+export type PayloadWritable = {
+    kind: 'jpeg';
+    /**
+     * Data required on write
+     */
+    encoded: string;
+};
+
+export type ItemCreateData = {
+    body: CreateItemRequest;
+    path?: never;
+    query?: never;
+    url: '/items';
+};
+
+export type ItemCreateResponses = {
+    /**
+     * Created
+     */
+    201: unknown;
+};

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transforms-read-write-response/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type * from './types.gen';

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/transforms-read-write-response/types.gen.ts

@@ -0,0 +1,41 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type ItemListResponse = {
+    items: Array<Item>;
+};
+
+export type Item = {
+    /**
+     * Server-generated ID
+     */
+    readonly id: string;
+    name: string;
+    /**
+     * Server-generated timestamp
+     */
+    readonly created_at?: string;
+};
+
+export type ItemWritable = {
+    name: string;
+};
+
+export type ItemListData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/items';
+};
+
+export type ItemListResponses = {
+    /**
+     * Success
+     */
+    200: ItemListResponse;
+};
+
+export type ItemListResponse2 = ItemListResponses[keyof ItemListResponses];

packages/openapi-ts/src/openApi/shared/transforms/readWrite.ts

@@ -464,6 +464,7 @@ type WalkArgs = {
   inSchema: boolean;
   node: unknown;
   path: ReadonlyArray<string | number>;
+  visited?: Set<string>;
 };
 
 /**
@@ -474,10 +475,12 @@ type WalkArgs = {
  * @param split - The split mapping (from splitSchemas)
  */
 export const updateRefsInSpec = ({
+  graph,
   logger,
   spec,
   split,
 }: {
+  graph: Graph;
   logger: Logger;
   spec: unknown;
   split: Omit<SplitSchemas, 'schemas'>;
@@ -491,6 +494,7 @@ export const updateRefsInSpec = ({
     inSchema,
     node,
     path,
+    visited = new Set(),
   }: WalkArgs): void => {
     if (node instanceof Array) {
       node.forEach((item, index) =>
@@ -500,6 +504,7 @@ export const updateRefsInSpec = ({
           inSchema,
           node: item,
           path: [...path, index],
+          visited,
         }),
       );
     } else if (node && typeof node === 'object') {
@@ -519,6 +524,21 @@ export const updateRefsInSpec = ({
           } else if (mapping?.write === nextPointer) {
             nextContext = 'write';
           }
+        } else {
+          // Not a split variant - check graph for the schema's scopes
+          const nodeInfo = graph.nodes.get(nextPointer);
+          if (nodeInfo?.scopes) {
+            // If schema has only write scope, use write context
+            // If schema has only read scope, use read context
+            // If schema has both or neither, leave context as-is (null)
+            const hasRead = nodeInfo.scopes.has('read');
+            const hasWrite = nodeInfo.scopes.has('write');
+            if (hasWrite && !hasRead) {
+              nextContext = 'write';
+            } else if (hasRead && !hasWrite) {
+              nextContext = 'read';
+            }
+          }
         }
       }
 
@@ -535,6 +555,7 @@ export const updateRefsInSpec = ({
             inSchema: false,
             node: (node as Record<string, unknown>)[key],
             path: [...path, key],
+            visited,
           });
         }
         return;
@@ -555,6 +576,7 @@ export const updateRefsInSpec = ({
               inSchema: false,
               node: value,
               path: [...path, key],
+              visited,
             });
             continue;
           }
@@ -565,6 +587,7 @@ export const updateRefsInSpec = ({
               inSchema: false,
               node: value,
               path: [...path, key],
+              visited,
             });
             continue;
           }
@@ -577,6 +600,7 @@ export const updateRefsInSpec = ({
                   inSchema: true,
                   node: param.schema,
                   path: [...path, key, index, 'schema'],
+                  visited,
                 });
               }
               // Also handle content (OpenAPI 3.x)
@@ -587,6 +611,7 @@ export const updateRefsInSpec = ({
                   inSchema: false,
                   node: param.content,
                   path: [...path, key, index, 'content'],
+                  visited,
                 });
               }
             });
@@ -608,6 +633,7 @@ export const updateRefsInSpec = ({
                 inSchema: false,
                 node: (value as Record<string, unknown>)[headerKey],
                 path: [...path, key, headerKey],
+                visited,
               });
             }
             continue;
@@ -622,15 +648,20 @@ export const updateRefsInSpec = ({
             inSchema: true,
             node: value,
             path: [...path, key],
+            visited,
           });
         } else if (key === '$ref' && typeof value === 'string') {
           // Prefer exact match first
           const map = split.mapping[value];
           if (map) {
-            if (map.read && (!nextContext || nextContext === 'read')) {
+            if (nextContext === 'read' && map.read) {
               (node as Record<string, unknown>)[key] = map.read;
-            } else if (map.write && (!nextContext || nextContext === 'write')) {
+            } else if (nextContext === 'write' && map.write) {
               (node as Record<string, unknown>)[key] = map.write;
+            } else if (!nextContext && map.read) {
+              // For schemas with no context (unused in operations), default to read variant
+              // This ensures $refs in unused schemas don't point to removed originals
+              (node as Record<string, unknown>)[key] = map.read;
             }
           }
         } else {
@@ -640,6 +671,7 @@ export const updateRefsInSpec = ({
             inSchema,
             node: value,
             path: [...path, key],
+            visited,
           });
         }
       }
@@ -679,6 +711,6 @@ export const readWriteTransform = ({
   const originalSchemas = captureOriginalSchemas(spec, logger);
   const split = splitSchemas({ config, graph, logger, spec });
   insertSplitSchemasIntoSpec({ logger, spec, split });
-  updateRefsInSpec({ logger, spec, split });
+  updateRefsInSpec({ graph, logger, spec, split });
   removeOriginalSplitSchemas({ logger, originalSchemas, spec, split });
 };

specs/3.1.x/transforms-read-write-nested.yaml

@@ -0,0 +1,39 @@
+openapi: 3.0.3
+info:
+  title: writeOnly repro
+  version: 1.0.0
+paths:
+  /items:
+    post:
+      operationId: item_create
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateItemRequest'
+      responses:
+        '201':
+          description: Created
+components:
+  schemas:
+    CreateItemRequest:
+      type: object
+      required:
+        - payload
+      properties:
+        payload:
+          $ref: '#/components/schemas/Payload'
+    Payload:
+      type: object
+      required:
+        - kind
+        - encoded
+      properties:
+        kind:
+          type: string
+          enum: [jpeg]
+        encoded:
+          type: string
+          writeOnly: true
+          description: Data required on write

specs/3.1.x/transforms-read-write-response.yaml

@@ -0,0 +1,43 @@
+openapi: 3.0.3
+info:
+  title: readOnly response test
+  version: 1.0.0
+paths:
+  /items:
+    get:
+      operationId: item_list
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ItemListResponse'
+components:
+  schemas:
+    ItemListResponse:
+      type: object
+      required:
+        - items
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/Item'
+    Item:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: string
+          readOnly: true
+          description: Server-generated ID
+        name:
+          type: string
+        created_at:
+          type: string
+          format: date-time
+          readOnly: true
+          description: Server-generated timestamp