Skip to content

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

Merged
dolauli merged 1 commit into
Azure:mainfrom
dolauli:tsp-brown
Aug 14, 2025
Merged

tsp - Add description for array body and path parameter if missing#1505
dolauli merged 1 commit into
Azure:mainfrom
dolauli:tsp-brown

Conversation

@dolauli

@dolauli dolauli commented Aug 14, 2025

Copy link
Copy Markdown
Contributor

This pull request improves how parameter and array schema descriptions are generated in the TypeSpec PowerShell converter, leading to more informative and user-friendly documentation output. The main changes focus on enhancing the fallback logic for descriptions when explicit documentation is missing.

Improvements to description generation:

  • In convertor.ts, the logic for creating a parameter description now falls back to the schema's description if explicit documentation is unavailable, ensuring that parameters always have a meaningful description.
  • In modelUtils.ts, array schema descriptions now use available documentation or, if missing, generate a description like "Array of [type name]", making array types clearer in generated docs.

@dolauli
dolauli merged commit 26399c4 into Azure:main Aug 14, 2025
103 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant