No parameters are created in the mock file.

[jonsoku-dev]

As for the mock file, neither parameters nor headers are applied, making it difficult to test using the mock server. After reviewing all issues and PRs, I was surprised to find no questions or discussions about this. Is there something that I'm overlooking?

However, the current example seems exactly the same.
here here2
here3

If the implementation is correct now, how should we go about using the mock server? I am specifically interested in using limit, offset, or error mock handlers, among other features.

I'm currently confused and could use your help and guidance.

petstore.yaml

openapi: '3.0.0'
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pets'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - 'name'
                - 'tag'
              properties:
                name:
                  type: string
                tag:
                  type: string
      responses:
        '201':
          description: Null response
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /pets/{petId}:
    get:
      summary: Info for a specific pet
      operationId: showPetById
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
        - name: testId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Pet:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Pets:
      type: array
      items:
        $ref: '#/components/schemas/Pet'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

/pets

     parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: string

orval.config.ts

import { faker } from "@faker-js/faker";
import { defineConfig } from "orval";
// import transformer from "./src/server/orval/transformer/add-version.js";

// sample swagger api
// https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml

export default defineConfig({
  "petstore-file": {
    input: "./src/server/orval/petstore.yaml",
    output: "./src/server/orval/endpoints/petstoreFromFileSpecWithConfig.ts",
  },
  "petstore-file-transfomer": {
    /**
     * @see https://orval.dev/reference/configuration/output
     */
    output: {
      mode: "split",
      client: "axios",
      target:
        "./src/server/orval/endpoints/petstoreFromFileSpecWithTransformer.ts",
      schemas: "./src/server/orval/model",
      tslint: true,
      prettier: true,
      mock: {
        type: "msw",
        delay: 300,
        useExamples: false,
      },
      override: {
        mutator: {
          path: "src/server/orval/mutator/custom-instance.ts",
          name: "customInstance",
        },
        operations: {
          listPets: {
            mock: {
              properties: () => {
                return {
                  "[].id": () => faker.number.int({ min: 1, max: 99999 }),
                };
              },
            },
          },
          showPetById: {
            mock: {
              data: () => ({
                id: faker.number.int({ min: 1, max: 99 }),
                name: faker.person.firstName(),
                tag: faker.helpers.arrayElement([
                  faker.word.sample(),
                  undefined,
                ]),
              }),
            },
          },
        },
        // mock: {
        //   properties: {
        //     "/tag|name/": "jon",
        //   },
        // },
      },
    },
    input: {
      target: "./src/server/orval/petstore.yaml",
      override: {
        transformer: "src/server/orval/transformer/add-version.cjs",
      },
    },
  },
});

petstoreFromFileSpecWithTransformer.ts

/**
 * Generated by orval v6.23.0 🍺
 * Do not edit manually.
 * Swagger Petstore
 * OpenAPI spec version: 1.0.0
 */
import type { CreatePetsBody, ListPetsParams, Pet, Pets } from "../model";
import { customInstance } from "../mutator/custom-instance";

export const getSwaggerPetstore = () => {
  /**
   * @summary List all pets
   */
  const listPets = (params?: ListPetsParams, version: number = 1) => {
    return customInstance<Pets>({
      url: `/v${version}/pets`,
      method: "GET",
      params,
    });
  };

  /**
   * @summary Create a pet
   */
  const createPets = (createPetsBody: CreatePetsBody, version: number = 1) => {
    return customInstance<void>({
      url: `/v${version}/pets`,
      method: "POST",
      headers: { "Content-Type": "application/json" },
      data: createPetsBody,
    });
  };

  /**
   * @summary Info for a specific pet
   */
  const showPetById = (petId: string, version: number = 1) => {
    return customInstance<Pet>({
      url: `/v${version}/pets/${petId}`,
      method: "GET",
    });
  };

  return { listPets, createPets, showPetById };
};
export type ListPetsResult = NonNullable<
  Awaited<ReturnType<ReturnType<typeof getSwaggerPetstore>["listPets"]>>
>;
export type CreatePetsResult = NonNullable<
  Awaited<ReturnType<ReturnType<typeof getSwaggerPetstore>["createPets"]>>
>;
export type ShowPetByIdResult = NonNullable<
  Awaited<ReturnType<ReturnType<typeof getSwaggerPetstore>["showPetById"]>>
>;

petstoreFromFileSpecWithTransformer.msw.ts

Why is the argument all of the function blank?

/**
 * Generated by orval v6.23.0 🍺
 * Do not edit manually.
 * Swagger Petstore
 * OpenAPI spec version: 1.0.0
 */
import { faker } from "@faker-js/faker";
import { HttpResponse, delay, http } from "msw";

export const getListPetsMock = () =>
  Array.from(
    { length: faker.number.int({ min: 1, max: 10 }) },
    (_, i) => i + 1,
  ).map(() => ({
    id: (() => faker.number.int({ min: 1, max: 99999 }))(),
    name: faker.word.sample(),
    tag: faker.helpers.arrayElement([faker.word.sample(), undefined]),
  }));

export const getShowPetByIdMock = () =>
  (() => ({
    id: faker.number.int({ min: 1, max: 99 }),
    name: faker.person.firstName(),
    tag: faker.helpers.arrayElement([faker.word.sample(), void 0]),
  }))();

export const getSwaggerPetstoreMock = () => [
  http.get("*/v:version/pets", async () => {
    await delay(300);
    return new HttpResponse(JSON.stringify(getListPetsMock()), {
      status: 200,
      headers: {
        "Content-Type": "application/json",
      },
    });
  }),
  http.post("*/v:version/pets", async () => {
    await delay(300);
    return new HttpResponse(null, {
      status: 200,
      headers: {
        "Content-Type": "application/json",
      },
    });
  }),
  http.get("*/v:version/pets/:petId", async () => {
    await delay(300);
    return new HttpResponse(JSON.stringify(getShowPetByIdMock()), {
      status: 200,
      headers: {
        "Content-Type": "application/json",
      },
    });
  }),
];