UpdateSpecBody

Request body for updating a Spec.

Definition

TypeScript

interface UpdateSpecBody {
  name?: string | undefined;
  description?: string | null | undefined;
  sourceUrl?: string | undefined;
  baseUrl?: string | null | undefined;
  authHeaderName?: string | null | undefined;
  authValuePrefix?: string | null | undefined;
  authSecretId?: string | null | undefined;
  solutionId?: string | null | undefined;
}

Fields

Field	Type	Notes
`name`	`string \| undefined`	`optional` — New spec name.
`description`	`string \| null \| undefined`	`optional` — Updated description; `null` clears the existing one.
`sourceUrl`	`string \| undefined`	`optional` — New spec URL. Changing this does NOT trigger a refresh — call refresh explicitly afterward.
`baseUrl`	`string \| null \| undefined`	`optional` — New base URL override; `null` clears the override.
`authHeaderName`	`string \| null \| undefined`	`optional` — New auth header name; `null` removes auth.
`authValuePrefix`	`string \| null \| undefined`	`optional` — New auth value prefix; `null` clears the prefix.
`authSecretId`	`string \| null \| undefined`	`optional` — New auth secret reference; `null` removes the secret link.
`solutionId`	`string \| null \| undefined`	`optional` — Move generated entities into a different solution, or unwrap them by passing `null`.