Skip to content

Add-PodeOAComponentSchema

SYNOPSIS

Adds a reusable component for a request body.

SYNTAX

Add-PodeOAComponentSchema [-Name] <String> [-Schema] <Hashtable> [<CommonParameters>]

DESCRIPTION

Adds a reusable component for a request body.

EXAMPLES

EXAMPLE 1

Add-PodeOAComponentSchema -Name 'UserIdSchema' -Schema (New-PodeOAIntProperty -Name 'userId' -Object)

PARAMETERS

-Name

The reference Name of the schema.

Type: String
Parameter Sets: (All)
Aliases:

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

-Schema

The Schema definition (the schema is created using the Property functions).

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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