New-KrOpenApiLink

SYNOPSIS

Creates a new OpenAPI Link object.

SYNTAX

ByOperationId (Default)

New-KrOpenApiLink -OperationId <string> [-Server <KestrunHost>] [-Description <string>]
 [-OpenApiServer <OpenApiServer>] [-Parameters <IDictionary>] [-RequestBody <Object>]
 [-Extensions <IDictionary>] [<CommonParameters>]

ByOperationRef

New-KrOpenApiLink -OperationRef <string> [-Server <KestrunHost>] [-Description <string>]
 [-OpenApiServer <OpenApiServer>] [-Parameters <IDictionary>] [-RequestBody <Object>]
 [-Extensions <IDictionary>] [<CommonParameters>]

ALIASES

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

DESCRIPTION

This function creates a new OpenAPI Link object that can be used to define relationships between operations in an OpenAPI specification. Links allow you to specify how the output of one operation can be used as input to another operation.

EXAMPLES

EXAMPLE 1

$link = New-KrOpenApiLink -OperationId “getUser” -Description “Link to get user details” -Parameters @{ “userId” = “$response.body#/id” } This link creates a new OpenAPI Link object that links to the “getUser” operation, with a description and parameters.

EXAMPLE 2

$link = New-KrOpenApiLink -OperationRef “#/paths/~1users~1{userId}/get” -Description “Link to get user details” This link creates a new OpenAPI Link object that links to the operation referenced by the provided JSON Reference, with a description.

PARAMETERS

-Description

A description of the link.

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

-Extensions

A collection of OpenAPI extensions to add to the link.

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

-OpenApiServer

An OpenAPI Server object that specifies the server to be used for the linked operation.

Type: Microsoft.OpenApi.OpenApiServer
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OperationId

The operationId of an existing operation in the OpenAPI specification.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByOperationId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-OperationRef

A reference to an existing operation in the OpenAPI specification using a JSON Reference.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByOperationRef
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Parameters

A hashtable mapping parameter names to runtime expressions or literal objects that define the parameters for the linked operation.

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

-RequestBody

A runtime expression or literal object that defines the request body for the linked operation.

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

-Server

The Kestrun server instance to which the OpenAPI link will be associated. 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: Named
  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

OUTPUTS

Microsoft.OpenApi.OpenApiLink object.

Microsoft.OpenApi.OpenApiLink

NOTES

This function is part of the Kestrun PowerShell module for working with OpenAPI specifications.