Build-KrOpenApiDocument

SYNOPSIS

Builds the OpenAPI document for the specified Kestrun server.

SYNTAX

__AllParameterSets 

Build-KrOpenApiDocument [[-Server] <KestrunHost>] [[-DocId] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

This function builds the OpenAPI document for the specified Kestrun server using the discovered components.

EXAMPLES

EXAMPLE 1

Build the OpenAPI document for the default document ID

Build-KrOpenApiDocument -Server $myServer -DocId ‘default’

PARAMETERS

-DocId

The ID of the OpenAPI document to build. Default is ‘default’.

Type: System.String
DefaultValue: Default
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Server

The Kestrun server instance for which the OpenAPI document will be built. If not specified, the function will attempt to resolve the current server context.

Type: Kestrun.Hosting.KestrunHost
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Kestrun.Hosting.KestrunHost

{{ Fill in the Description }}

OUTPUTS

Kestrun.OpenApi.OpenApiDocumentDescriptor

{{ Fill in the Description }}

NOTES

{{ Fill in the related links here }}