fix(openapi): recognize bare object type + document existing field on validate (#1532)

* fix(openapi): recognize bare `object` type in annotation parser

The @openapi annotation parser's parseMiniSchema() only recognized the
bare words integer/number/boolean/string as scalar types. Any other
bare word - including `object`, used in 16 route annotations across
the codebase (e.g. severity:object, envVars:object on
POST /api/stacks/{name}/validate) - silently fell through to the
generic string fallback, so these fields were documented in
static/openapi.json as {"type": "string"} instead of
{"type": "object"}.

Add a dedicated branch for bare `object`, producing an opaque object
schema (no declared properties, since the bare word carries no shape
information of its own - a documented shape should use the existing
{...} form).

Verified no other bare non-standard word is used in any body:/resp-*:
annotation line across the 257 route files, so this closes the gap
completely for the current codebase.

Fixes #1531

* docs(openapi): document the existing field on POST /api/stacks/{name}/validate

The handler reads body.existing (an optional boolean, undocumented)
to control self-exclusion of the stack's own running containers/ports
from the cross-stack collision checks - the exact case the endpoint's
own summary advertises as handled. Without it, a client built strictly
from the OpenAPI document has no way to learn the field exists, and
will validate an existing stack the same way as a new one, silently
reintroducing false-positive collision findings against the stack's
own containers.

Add existing:boolean to the body: annotation, plus a one-line
description explaining the true/omitted semantics.

Fixes #1530

---------

Co-authored-by: Jarek Krochmalski <jotka@users.noreply.github.com>
This commit is contained in:
Björn StrausmannandJarek Krochmalski authored and GitHub committed 2026-09-06 15:51:12 +05:30
1 parent 360c458144
commit 33c0c47855
3 files changed
+32 -2

No files matched your search

+19
View File
@@ -41,6 +41,25 @@ describe('parseMiniSchema: always terminates + bracket arrays', () => {
test('array<T> long form still works (no regression)', () => {
expect(parseMiniSchema('array<string>')).toEqual({ kind: 'array', items: { kind: 'string' } });
});
test('bare `object` parses as an opaque object, not the string fallback', () => {
expect(parseMiniSchema('object')).toEqual({ kind: 'object', properties: {}, required: [] });
});
test('nested object with a bare `object` property (the real body: annotation on POST /api/stacks/{name}/validate — was silently "string")', () => {
// Before this fix, `severity` and `envVars` both fell through to
// `{ kind: 'string' }` because `parseType()` only recognized
// integer/number/boolean/string as bare words. `existing` (added for
// #1530) is a plain `boolean` and was never affected by this bug —
// included here only to keep this literal in sync with the real
// annotation.
const s = parseMiniSchema(
'{compose:string!, existing:boolean, config:{disabled:[string], severity:object}, envVars:object}'
);
expect((s as any).properties.config.properties.severity).toEqual({ kind: 'object', properties: {}, required: [] });
expect((s as any).properties.envVars).toEqual({ kind: 'object', properties: {}, required: [] });
expect((s as any).properties.existing).toEqual({ kind: 'boolean' });
});
});
describe('parseAnnotations: non-JSON request bodies', () => {