Duolith docs

Errors E0500 to E0599

E0517 Part of an API description Duolith cannot type

Message what in file cannot be turned into a type

Words in italics are filled in when the compiler reports it, such as the element's name or the list of known ones.

Why

The typed client gives each operation's parameters, body and answer a TypeScript type. A schema that names another file, a $ref that leads back to itself outside #/components/schemas, a named schema that is only itself, and a schema that says nothing about its shape ({}, not:, an array without items, a body or answer with no schema) would leave that part unchecked, or could never be written, so the build fails instead (decision 0109).

How to fix it

Keep every $ref inside the file, name a schema that refers to itself under #/components/schemas/ (it becomes a named type that may refer to itself), and give every schema a type.

In a terminal

duolith explain E0517

Mentioned in