RefreshSpecResponse
Response payload for a Spec endpoint.
Definition
TypeScript
interface RefreshSpecResponse {
spec: {
id: string;
workspaceId: string;
name: string;
description: string | null;
sourceUrl: string;
specFormat: "openapi-3.0" | "openapi-3.1" | "swagger-2.0";
currentVersionId: string | null;
baseUrl: string | null;
authHeaderName: string | null;
authValuePrefix: string | null;
authSecretId: string | null;
solutionId: string | null;
createdBy: string;
deletedAt: string | null;
retentionTier: "short" | "medium" | "long" | "none" | null;
createdAt: string;
updatedAt: string;
};
version: {
id: string;
specId: string;
version: string;
spec: unknown;
parentId: string | null;
fetchedAt: string;
};
diff: {
added: number;
modified: number;
removed: number;
unchanged: boolean;
};
}Fields
| Field | Type | Notes |
|---|---|---|
spec | { id: string; workspaceId: string; name: string; description: string | null; sourceUrl: string; specFormat: "openapi-3.0" | "openapi-3.1" | "swagger-2.0"; currentVersionId: string | null; baseUrl: string | null; authHeaderName: string | null; authValuePrefix: string | null; authSecretId: string | null; solutionId: string | null; createdBy: string; deletedAt: string | null; retentionTier: "short" | "medium" | "long" | "none" | null; createdAt: string; updatedAt: string; } | required |
version | { id: string; specId: string; version: string; spec: unknown; parentId: string | null; fetchedAt: string; } | required — The new (or existing, if unchanged) version row. |
diff | { added: number; modified: number; removed: number; unchanged: boolean; } | required — Summary of what changed between the previous version and the new one. |