< Summary - Kestrun — Combined Coverage

Information

Class:	Public.OpenAPI.New-KrOpenApiExternalDoc
Assembly:	Kestrun.PowerShell.Public
File(s):	/home/runner/work/Kestrun/Kestrun/src/PowerShell/Kestrun/Public/OpenAPI/New-KrOpenApiExternalDoc.ps1
Tag:	Kestrun/Kestrun@0d738bf294e6281b936d031e1979d928007495ff

Line coverage

Branch coverage

N/A

Method coverage

Feature is only available for sponsors

Coverage history

Method
New-KrOpenApiExternalDoc()

#	Line	Line coverage
	`1`	`<#`
	`2`	`.SYNOPSIS`
	`3`	`Creates a new OpenAPI external documentation object.`
	`4`	`.DESCRIPTION`
	`5`	`This function creates a new OpenAPI external documentation object using the provided parameters.`
	`6`	`.PARAMETER Description`
	`7`	`A description of the external documentation.`
	`8`	`.PARAMETER Url`
	`9`	`A URI to the external documentation.`
	`10`	`.EXAMPLE`
	`11`	`$externalDocs = New-KrOpenApiExternalDoc -Description 'Find out more about our API here.' -Url 'https://example.com/`
	`12`	`.OUTPUTS`
	`13`	`Microsoft.OpenApi.OpenApiExternalDocs`
	`14`	`.NOTES`
	`15`	`This cmdlet is part of the OpenAPI module.`
	`16`	`#>`
	`17`	`function New-KrOpenApiExternalDoc {`
	`18`	`[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')]`
	`19`	`[KestrunRuntimeApi('Everywhere')]`
	`20`	`[OutputType([Microsoft.OpenApi.OpenApiExternalDocs])]`
	`21`	`param(`
	`22`	`[Parameter()]`
	`23`	`[string]$Description,`
	`24`	`[Parameter(Mandatory = $true)]`
	`25`	`[Uri]$Url`
	`26`	`)`
	`27`
0	`28`	`$externalDocs = [Microsoft.OpenApi.OpenApiExternalDocs]::new()`
	`29`
0	`30`	`if ($PsBoundParameters.ContainsKey('Description')) {`
0	`31`	`$externalDocs.Description = $Description`
	`32`	`}`
0	`33`	`$externalDocs.Url = $Url`
	`34`
0	`35`	`return $externalDocs`
	`36`	`}`