Skip to content

[V] $lib

const $lib: TypeSpecLibrary<object, OpenAPI3EmitterOptions, never>;

Type declaration

NameTypeDefault value
duplicate-headerobject-
duplicate-header.defaultCallableMessage<["header"]>-
empty-enumobject-
empty-enum.default"Empty enums are not supported for OpenAPI v3 - enums must have at least one value."”Empty enums are not supported for OpenAPI v3 - enums must have at least one value.”
empty-unionobject-
empty-union.default"Empty unions are not supported for OpenAPI v3 - enums must have at least one value."”Empty unions are not supported for OpenAPI v3 - enums must have at least one value.”
enum-unique-typeobject-
enum-unique-type.default"Enums are not supported unless all options are literals of the same type."”Enums are not supported unless all options are literals of the same type.”
inconsistent-shared-route-request-visibilityobject-
inconsistent-shared-route-request-visibility.default”All operations with `@sharedRoutes` must have the same `@requestVisibility`.""All operations with `@sharedRoutes` must have the same `@requestVisibility`.”
inline-cycleobject-
inline-cycle.defaultCallableMessage<["type"]>-
invalid-formatobject-
invalid-format.defaultCallableMessage<["value", "paramType"]>-
invalid-model-propertyobject-
invalid-model-property.defaultCallableMessage<["type"]>-
invalid-schemaobject-
invalid-schema.defaultCallableMessage<["type"]>-
invalid-server-variableobject-
invalid-server-variable.defaultCallableMessage<["propName"]>-
invalid-styleobject-
invalid-style.defaultCallableMessage<["style", "paramType"]>-
oneof-unionobject-
oneof-union.default"@oneOf decorator can only be used on a union or a model property which type is a union."”@oneOf decorator can only be used on a union or a model property which type is a union.”
path-queryobject-
path-query.default"OpenAPI does not allow paths containing a query string."-
path-reserved-expansionobject-
path-reserved-expansion.default"Reserved expansion of path parameter with '+' operator #{allowReserved: true} is not supported in OpenAPI3."-
resource-namespaceobject-
resource-namespace.default"Resource goes on namespace"”Resource goes on namespace”
status-code-in-default-responseobject-
status-code-in-default-response.default"a default response should not have an explicit status code"”a default response should not have an explicit status code”
union-nullobject-
union-null.default"Cannot have a union containing only null types."”Cannot have a union containing only null types.”
unsupported-authobject-
unsupported-auth.defaultCallableMessage<["authType"]>-
unsupported-status-code-rangeobject-
unsupported-status-code-range.defaultCallableMessage<["start", "end"]>-
xml-attribute-invalid-property-typeobject-
xml-attribute-invalid-property-type.defaultCallableMessage<["name"]>-
xml-unwrapped-invalid-property-typeobject-
xml-unwrapped-invalid-property-type.defaultCallableMessage<["name"]>-