Diagnostics
The following diagnostics can be reported by this library.
| Code | Severity | Description |
|---|---|---|
@typespec/openapi3/default-not-supported | warning | |
@typespec/openapi3/duplicate-header | error | |
@typespec/openapi3/empty-enum | error | Empty enums are not supported for OpenAPI v3 - enums must have at least one value. |
@typespec/openapi3/empty-union | error | Empty unions are not supported for OpenAPI v3 - enums must have at least one value. |
@typespec/openapi3/enum-strategy-not-supported | warning | enum-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-type | error | Enums are not supported unless all options are literals of the same type. |
@typespec/openapi3/inconsistent-shared-route-request-visibility | error | All operations with @sharedRoutes must have the same @requestVisibility. |
@typespec/openapi3/inline-cycle | error | |
@typespec/openapi3/invalid-component-fixed-field-key | warning | |
@typespec/openapi3/invalid-format | warning | |
@typespec/openapi3/invalid-model-property | error | |
@typespec/openapi3/invalid-schema | error | |
@typespec/openapi3/invalid-server-variable | error | |
@typespec/openapi3/invalid-style | warning | |
@typespec/openapi3/oneof-union | error | @oneOf decorator can only be used on a union or a model property which type is a union. |
@typespec/openapi3/path-query | error | OpenAPI does not allow paths containing a query string. |
@typespec/openapi3/path-reserved-expansion | warning | Reserved expansion of path parameter with ’+’ operator #{allowReserved: true} is not supported in OpenAPI3. |
@typespec/openapi3/resource-namespace | error | Resource goes on namespace |
@typespec/openapi3/status-code-in-default-response | error | a default response should not have an explicit status code |
@typespec/openapi3/streams-not-supported | warning | Streams 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-null | error | Cannot have a union containing only null types. |
@typespec/openapi3/unsupported-auth | warning | |
@typespec/openapi3/unsupported-status-code-range | error | |
@typespec/openapi3/xml-attribute-invalid-property-type | warning | |
@typespec/openapi3/xml-unwrapped-invalid-property-type | warning |