Devolutions ForumDevolutions Forum

Swagger documentation when -Path is used

Swagger documentation when -Path is used

avatar
(anonymous user) 
Product: PowerShell Universal
Version: 3.94


When moving endpoint definition to a file and using -Path instead of -Endpoint, it appears that any comment-based help isn’t included in the Swagger documentation. Is this expected behavior?

The first screenshot below is what the swagger documentation page looks like for an endpoint using -Path.
c87974552a19e288f6a0705d6e2ef6844d93c51b


This screenshot shows an endpoint defined in endpoints.ps1 using -Endpoint, and is what I would have expected even using -Path.


b611ab722b6b91aad63fbfb7e18b3c4e276df577

b611ab722b6b91aad63fbfb7e18b3c4e276df577.png

c87974552a19e288f6a0705d6e2ef6844d93c51b.png

All Comments (2)

avatar
Adam Driscoll

This isn’t expected behavior. I opened and issue to track this here: Endpoint Docs with -Path · Issue #2464 · ironmansoftware/issues · GitHub

I’ll circle back if I can’t reproduce it.

Adam Driscoll
PowerShell Expert and Developer at Devolutions

1
avatar

Left a commen in Github, but wanted to follow up here as well. I believe the issue came down to path definition, using $Repository at config time instead just at run time.

github.com/ironmansoftware/issues