Product: PowerShell Universal
Version: 3.9.8
Expected behavior: output definition appears under the endpoint on the swagger docs.
Current behavior: output definition appears under “schemas” on the swagger docs.
I’m having trouble getting the contents of .OUTPUT in my comment-based help to appear in the swagger documentation under the endpoint.
I believe that I’m defining the class and endpoint correctly. Here is my code in endpoints.ps1:
#region PSUHeader
#Use this section to include code that will not be overwritten by the Universal platform.
[Documentation()]
class PropertyResponse {
[string]$Name
}
#endregion
New-PSUEndpoint -Url "PropertyTest" -Description "Returns properties for syncing with Property Management" -Method @('GET') -Authentication -Role @('Administrator', 'SoftwareSolutionsAPI') -Endpoint {
<#
.SYNOPSIS
Returns properties from the database for consumption by Property Management.
.DESCRIPTION
Returns properties from the database for consumption by Property Management.
.PARAMETER APISource
The system calling the API.
.OUTPUTS
200:
Description: A successful return code.
Content:
application/json: PropertyResponse
500:
Description: Internal server error.
#>
[CmdletBinding()]
param (
[string]$APISource
)
'Gainesville Center - Basketball Court (Playground)'
}
Here is what I see on the swagger docs: