Skip to content

dpg-protocol-api-not-generated

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

Severity: warning

This diagnostic is issued when an Azure-flavored multipart operation would produce a protocol API that is not usable with the generated request shape.

Impact

Section titled “Impact”

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

Example Usage

Section titled “Example Usage”
model UploadForm {
  file: HttpPart<bytes>;
}


@post
op upload(@header contentType: "multipart/form-data", @multipartBody body: UploadForm): void;

Diagnostic Message

Section titled “Diagnostic Message”
Operation 'upload' is of content-type 'multipart/form-data'. Protocol API is not usable and hence not generated.

How to Address

Section titled “How to Address”

No change is required. Use the generated convenience API for the multipart operation.

Suppression

Section titled “Suppression”

It is safe to ignore or suppress this notification when the generated convenience API is sufficient.