Skip to content

dpg-convenience-api-not-generated

Id
@azure-tools/typespec-java/dpg-convenience-api-not-generated

Severity: warning

This diagnostic is issued when the Java emitter cannot form a safe convenience-method signature.

Impact

Section titled “Impact”

The protocol API remains available, but the convenience API is omitted for the operation.

Multiple Content Types

Section titled “Multiple Content Types”
@post
op upload(@body data: bytes, @header contentType: "application/octet-stream" | "image/png"): void;
options:
  "@azure-tools/typespec-java":
    flavor: azure

This TypeSpec definition is valid. Customize the generated Java library to add a convenience API with the appropriate method signature and behavior for the operation. The generated protocol API can be used as the underlying implementation.

JSON Merge Patch Without Stream-Style Serialization

Section titled “JSON Merge Patch Without Stream-Style Serialization”
@patch
op update(@header contentType: "application/merge-patch+json", @body body: WidgetPatch): void;
options:
  "@azure-tools/typespec-java":
    flavor: azure
    stream-style-serialization: false

Enable stream-style serialization:

options:
  "@azure-tools/typespec-java":
    flavor: azure
    stream-style-serialization: true

Diagnostic Message

Section titled “Diagnostic Message”

The message identifies either multiple content types or JSON merge patch as the reason the convenience API was not generated.

Suppression

Section titled “Suppression”

For multiple content types, suppress the warning after adding the required convenience API customization, or when a protocol-only API surface is intentional. Do not suppress the JSON merge patch warning; enable stream-style serialization instead.