Skip to content

tsp - Add description for array body and path parameter if missing #1505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dolauli merged 1 commit into from
Aug 14, 2025
Merged

tsp - Add description for array body and path parameter if missing #1505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/typespec-powershell/src/convertor/convertor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ function createParameter(psContext: SdkContext, parameter: HttpOperationParamete
} else {
// always create the parameter
const paramSchema = parameter.param.sourceProperty ? getSchemaForType(psContext, parameter.param.sourceProperty) : getSchemaForType(psContext, parameter.param);
const newParameter = new Parameter(parameter.name, getDoc(psContext.program, parameter.param) || "", paramSchema);
const newParameter = new Parameter(parameter.name, getDoc(psContext.program, parameter.param) || paramSchema.description || "", paramSchema);
newParameter.language.default.serializedName = parameter.name;
newParameter.protocol.http = newParameter.protocol.http ?? new Protocol();
newParameter.protocol.http.in = parameter.type;
Expand Down
4 changes: 3 additions & 1 deletion packages/typespec-powershell/src/utils/modelUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1227,7 +1227,9 @@ function getSchemaForArrayModel(
// }),
// description: getDoc(program, type)
// };
schema = new ArraySchema("", "", getSchemaForType(dpgContext, indexer.value!));
schema = new ArraySchema("", getDoc(program, type) || (indexer.value && "name" in indexer.value && typeof indexer.value.name === "string"
? "Array of " + indexer.value.name
: ""), getSchemaForType(dpgContext, indexer.value!));
// circle reference, resolve it later
if (!getSchemaForType(dpgContext, indexer.value!)) {
schema.delayType = indexer.value!;
Expand Down
Loading