Skip to content

Diagnostics

The following diagnostics can be reported by this library.

CodeSeverityDescription
@typespec/openapi3/default-not-supportedwarning
@typespec/openapi3/duplicate-headererror
@typespec/openapi3/empty-enumerrorEmpty enums are not supported for OpenAPI v3 - enums must have at least one value.
@typespec/openapi3/empty-unionerrorEmpty unions are not supported for OpenAPI v3 - enums must have at least one value.
@typespec/openapi3/enum-strategy-not-supportedwarningenum-strategy: annotated is only supported for OpenAPI 3.1.0 and above. The default enum strategy will be used for OpenAPI 3.0.0.
@typespec/openapi3/enum-unique-typeerrorEnums are not supported unless all options are literals of the same type.
@typespec/openapi3/inconsistent-shared-route-request-visibilityerrorAll operations with @sharedRoutes must have the same @requestVisibility.
@typespec/openapi3/inline-cycleerror
@typespec/openapi3/invalid-component-fixed-field-keywarning
@typespec/openapi3/invalid-formatwarning
@typespec/openapi3/invalid-model-propertyerror
@typespec/openapi3/invalid-schemaerror
@typespec/openapi3/invalid-server-variableerror
@typespec/openapi3/invalid-stylewarning
@typespec/openapi3/oneof-unionerror@oneOf decorator can only be used on a union or a model property which type is a union.
@typespec/openapi3/path-queryerrorOpenAPI does not allow paths containing a query string.
@typespec/openapi3/path-reserved-expansionwarningReserved expansion of path parameter with ’+’ operator #{allowReserved: true} is not supported in OpenAPI3.
@typespec/openapi3/resource-namespaceerrorResource goes on namespace
@typespec/openapi3/status-code-in-default-responseerrora default response should not have an explicit status code
@typespec/openapi3/streams-not-supportedwarningStreams with itemSchema are only fully supported in OpenAPI 3.2.0 or above. The response will be emitted without itemSchema. Consider using OpenAPI 3.2.0 for full stream support.
@typespec/openapi3/union-nullerrorCannot have a union containing only null types.
@typespec/openapi3/unsupported-authwarning
@typespec/openapi3/unsupported-status-code-rangeerror
@typespec/openapi3/xml-attribute-invalid-property-typewarning
@typespec/openapi3/xml-unwrapped-invalid-property-typewarning