request-body-problem

Full name

@azure-tools/typespec-azure-core/request-body-problem

Request body should not be of raw array type. Using an array as the top-level request body prevents adding new properties in the future without introducing breaking changes. Instead, create a container model that wraps the array.

❌ Incorrect

Raw array as request body:

op upload(@body body: string[]): string;

✅ Correct

Wrap the array in a model:

model StringList {
  value: string[];
}

op upload(@body body: StringList): string;

Note

Arrays in responses are allowed since response schemas are less likely to require additive changes.

op list(@body body: string): string[];