Skip to content

New-PodeOASchemaProperty

SYNOPSIS

Creates a OpenAPI schema reference property.

SYNTAX

New-PodeOASchemaProperty [[-Name] <String>] [-Reference] <String> [[-Description] <String>] [-Array]
 [<CommonParameters>]

DESCRIPTION

Creates a new OpenAPI schema reference from another OpenAPI schema.

EXAMPLES

EXAMPLE 1

New-PodeOASchemaProperty -Name 'Config' -ComponentSchema "MyConfigSchema"

PARAMETERS

-Array

If supplied, the schema reference will be treated as an array.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

A Description of the property.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The Name of the property.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Reference

An component schema name.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Back to top