fix: remove readOnly fields from body schema parsing before Zod generation

[yoshi2no]

Status

READY

Description

close #1548

• Updated parseBodyAndResponse to apply removeReadOnlyProperties when parsing the body, ensuring that readOnly fields are excluded before generating the Zod schema.
• This ensures that only non-readOnly fields are considered for the body schema

Related PRs

List related PRs against other branches:

branch	PR
other_pr_production	link
other_pr_master	link

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

Set up the following files and verify that the generated body schema does not include any properties that have readOnly set to true.

orval.config.js

import { defineConfig } from "orval";

export default defineConfig({
  petstore: {
    input: "./petstore.yaml",
    output: {
      client: "zod",
      target: "./src/generated/zod.ts",
      override: {},
    },
  },
});

petstore.yaml

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Simple User API
  license:
    name: MIT
servers:
  - url: http://example.com/v1
paths:
  /users:
    get:
      summary: List all users
      operationId: listUsers
      responses:
        "200":
          description: A list of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/User"
    post:
      summary: Create a user
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/User"
      responses:
        "201":
          description: User created successfully
  /users/multiple:
    post:
      summary: Create multiple users
      operationId: createMultipleUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/User"
      responses:
        "201":
          description: Users created successfully

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        username:
          type: string
          maxLength: 50
        email:
          type: string
          format: email
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - username
        - email

the output in my environment is as follows:

before the change

/**
 * Generated by orval v7.1.0 🍺
 * Do not edit manually.
 * Simple User API
 * OpenAPI spec version: 1.0.0
 */
import { z as zod } from "zod";

/**
 * @summary List all users
 */
export const listUsersResponseUsernameMax = 50;

export const listUsersResponseItem = zod.object({
  id: zod.string().uuid().optional(),
  username: zod.string().max(listUsersResponseUsernameMax),
  email: zod.string().email(),
  created_at: zod.string().datetime().optional(),
});
export const listUsersResponse = zod.array(listUsersResponseItem);

/**
 * @summary Create a user
 */
export const createUserBodyUsernameMax = 50;

export const createUserBody = zod.object({
  id: zod.string().uuid().optional(),
  username: zod.string().max(createUserBodyUsernameMax),
  email: zod.string().email(),
  created_at: zod.string().datetime().optional(),
});

/**
 * @summary Create multiple users
 */
export const createMultipleUsersBodyUsernameMax = 50;

export const createMultipleUsersBodyItem = zod.object({
  id: zod.string().uuid().optional(),
  username: zod.string().max(createMultipleUsersBodyUsernameMax),
  email: zod.string().email(),
  created_at: zod.string().datetime().optional(),
});
export const createMultipleUsersBody = zod.array(createMultipleUsersBodyItem);

after the change

/**
 * Generated by orval v7.1.0 🍺
 * Do not edit manually.
 * Simple User API
 * OpenAPI spec version: 1.0.0
 */
import { z as zod } from "zod";

/**
 * @summary List all users
 */
export const listUsersResponseUsernameMax = 50;

export const listUsersResponseItem = zod.object({
  id: zod.string().uuid().optional(),
  username: zod.string().max(listUsersResponseUsernameMax),
  email: zod.string().email(),
  created_at: zod.string().datetime().optional(),
});
export const listUsersResponse = zod.array(listUsersResponseItem);

/**
 * @summary Create a user
 */
export const createUserBodyUsernameMax = 50;

export const createUserBody = zod.object({
  username: zod.string().max(createUserBodyUsernameMax),
  email: zod.string().email(),
});

/**
 * @summary Create multiple users
 */
export const createMultipleUsersBodyUsernameMax = 50;

export const createMultipleUsersBodyItem = zod.object({
  username: zod.string().max(createMultipleUsersBodyUsernameMax),
  email: zod.string().email(),
});
export const createMultipleUsersBody = zod.array(createMultipleUsersBodyItem);

[JargeZ]

❤️