Individual skill

orval

Orval OpenAPI TypeScript client generation best practices. This skill should be used when configuring Orval, generating TypeScript clients from OpenAPI specs, setting up React Query/SWR hooks, creating custom mutators, or writing MSW mocks. Triggers on tasks involving orval.config.ts, OpenAPI codegen, API client setup, or mock generation.

skills/.experimental/orval/SKILL.md

Read pinned source

Source commit cf93c57cac89d6fc3e4194686000411567f5caf3

What was checked

Matches the observed repository HEAD: Yes
Scanner rules are current: No
Repository scan complete: No
Skill scan complete: Yes
Observed behavior: Not checked yet
Last checked: Nov 5, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings): 222
Repository last updated: Aug 15, 2026
License: MIT

Observed agent integration: codex

writing Derived category
docs Derived category
engineering Derived category
docs-api Derived category
engineering-web Derived category

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files

AGENTS.mddoc · 8,983 bytes
README.mddoc · 4,220 bytes
SKILL.mdcore · 5,342 bytes
assets/templates/_template.mddoc · 775 bytes
metadata.jsonasset · 815 bytes
references/_sections.mddoc · 1,730 bytes
references/adv-form-data-handling.mddoc · 1,934 bytes
references/adv-input-transformer.mddoc · 2,018 bytes
references/adv-operation-override.mddoc · 2,175 bytes
references/adv-output-transformer.mddoc · 2,196 bytes
references/mock-delay-config.mddoc · 2,007 bytes
references/mock-http-status.mddoc · 1,977 bytes
references/mock-index-files.mddoc · 2,034 bytes
references/mock-msw-generation.mddoc · 1,990 bytes
references/mock-use-examples.mddoc · 1,819 bytes
references/mutator-body-wrapper.mddoc · 2,045 bytes
references/mutator-custom-instance.mddoc · 1,963 bytes
references/mutator-error-types.mddoc · 2,054 bytes
references/mutator-fetch-client.mddoc · 2,233 bytes
references/mutator-interceptors.mddoc · 2,246 bytes
references/mutator-token-refresh.mddoc · 2,693 bytes
references/oquery-hook-options.mddoc · 2,021 bytes
references/oquery-infinite-queries.mddoc · 1,991 bytes
references/oquery-key-export.mddoc · 2,037 bytes
references/oquery-mutation-callbacks.mddoc · 2,139 bytes
references/oquery-signal-cancellation.mddoc · 1,899 bytes
references/oquery-suspense-support.mddoc · 2,022 bytes
references/orvalcfg-baseurl-setup.mddoc · 1,932 bytes
references/orvalcfg-client-selection.mddoc · 1,744 bytes
references/orvalcfg-input-validation.mddoc · 1,592 bytes
references/orvalcfg-mode-selection.mddoc · 1,548 bytes
references/orvalcfg-prettier-format.mddoc · 1,565 bytes
references/orvalcfg-separate-schemas.mddoc · 1,805 bytes
references/output-clean-target.mddoc · 1,636 bytes
references/output-file-extension.mddoc · 1,630 bytes
references/output-headers-enabled.mddoc · 1,591 bytes
references/output-index-files.mddoc · 1,682 bytes
references/output-naming-convention.mddoc · 1,845 bytes
references/spec-operationid-unique.mddoc · 1,415 bytes
references/spec-required-fields.mddoc · 1,833 bytes
references/spec-response-types.mddoc · 2,229 bytes
references/spec-schemas-reusable.mddoc · 2,131 bytes
references/spec-tags-organization.mddoc · 1,862 bytes
references/types-bigint-support.mddoc · 2,071 bytes
references/types-use-dates.mddoc · 2,043 bytes
references/types-zod-coerce.mddoc · 1,824 bytes
references/types-zod-strict.mddoc · 1,770 bytes
references/types-zod-validation.mddoc · 2,173 bytes

Read excerpt


# Orval OpenAPI Best Practices

Comprehensive guide for generating type-safe TypeScript clients from OpenAPI specifications using Orval. Contains 42 rules across 8 categories, prioritized by impact to guide automated configuration, client generation, and testing setup.

## When to Apply

Reference these guidelines when:
- Configuring Orval for a new project
- Setting up OpenAPI-based TypeScript client generation
- Integrating React Query, SWR, or Vue Query with generated hooks
- Creating custom mutators for authentication and error handling
- Generating MSW mocks for testing

## Rule Categories by Priority