fix(frontend): unblock pnpm generate:api after orval v8 upgrade (#11346 )

Orval v8's pre-generation validator (@scalar/openapi-parser) treats every `$ref` key as a JSON Reference. Our spec embeds Perses' `common.JSONRef` struct, which has a property literally named `$ref`, so validation aborts with `INVALID_REFERENCE`. Set `input.unsafeDisableValidation: true` to bypass — codegen itself handles the spec correctly, and the spec is backend-generated and CI-gated. Closes SigNoz/engineering-pod#4963
2026-05-18 16:00:32 +01:00 · 2026-05-18 14:33:23 +00:00
30 changed files with 7 additions and 29 deletions
--- a/frontend/orval.config.ts
+++ b/frontend/orval.config.ts
@@ -10,6 +10,13 @@ export default defineConfig({
 	signoz: {
 		input: {
 			target: '../docs/api/openapi.yml',
+			// Perses' `common.JSONRef` (used by `DashboardGridItem.content`) has a
+			// field tagged `json:"$ref"`, so our spec contains a property literally
+			// named `$ref`.
+			// Orval v8's validator (`@scalar/openapi-parser`) treats every `$ref` key
+			// as a JSON Reference and aborts with `INVALID_REFERENCE` when the value isn't a URI string.
+			// Safe to disable: yes, the spec is generated by `cmd/openapi.go` and gated by backend CI, not hand-edited.
+			unsafeDisableValidation: true,
 		},
 		output: {
 			target: './src/api/generated/services',
--- a/frontend/src/api/generated/services/alerts/index.ts
+++ b/frontend/src/api/generated/services/alerts/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/authdomains/index.ts
+++ b/frontend/src/api/generated/services/authdomains/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/authz/index.ts
+++ b/frontend/src/api/generated/services/authz/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/channels/index.ts
+++ b/frontend/src/api/generated/services/channels/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/cloudintegration/index.ts
+++ b/frontend/src/api/generated/services/cloudintegration/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/dashboard/index.ts
+++ b/frontend/src/api/generated/services/dashboard/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/downtimeschedules/index.ts
+++ b/frontend/src/api/generated/services/downtimeschedules/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/features/index.ts
+++ b/frontend/src/api/generated/services/features/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/fields/index.ts
+++ b/frontend/src/api/generated/services/fields/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/gateway/index.ts
+++ b/frontend/src/api/generated/services/gateway/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/global/index.ts
+++ b/frontend/src/api/generated/services/global/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/health/index.ts
+++ b/frontend/src/api/generated/services/health/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/inframonitoring/index.ts
+++ b/frontend/src/api/generated/services/inframonitoring/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/llmpricingrules/index.ts
+++ b/frontend/src/api/generated/services/llmpricingrules/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/logs/index.ts
+++ b/frontend/src/api/generated/services/logs/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/metrics/index.ts
+++ b/frontend/src/api/generated/services/metrics/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/orgs/index.ts
+++ b/frontend/src/api/generated/services/orgs/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/preferences/index.ts
+++ b/frontend/src/api/generated/services/preferences/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/querier/index.ts
+++ b/frontend/src/api/generated/services/querier/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/role/index.ts
+++ b/frontend/src/api/generated/services/role/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/routepolicies/index.ts
+++ b/frontend/src/api/generated/services/routepolicies/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/rules/index.ts
+++ b/frontend/src/api/generated/services/rules/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/serviceaccount/index.ts
+++ b/frontend/src/api/generated/services/serviceaccount/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/sessions/index.ts
+++ b/frontend/src/api/generated/services/sessions/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/sigNoz.schemas.ts
+++ b/frontend/src/api/generated/services/sigNoz.schemas.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 export interface AlertmanagertypesChannelDTO {
 	/**
--- a/frontend/src/api/generated/services/spanmapper/index.ts
+++ b/frontend/src/api/generated/services/spanmapper/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/tracedetail/index.ts
+++ b/frontend/src/api/generated/services/tracedetail/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/users/index.ts
+++ b/frontend/src/api/generated/services/users/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {
--- a/frontend/src/api/generated/services/zeus/index.ts
+++ b/frontend/src/api/generated/services/zeus/index.ts
@@ -3,7 +3,6 @@
 * * The file has been auto-generated using Orval for SigNoz
 * * regenerate with 'pnpm generate:api'
 * SigNoz
- * OpenAPI spec version: 0.0.1
 */
 import { useMutation, useQuery } from 'react-query';
 import type {