Add-PodeOAComponentRequestBody
SYNOPSIS
Adds a reusable component for a request body.
SYNTAX
Add-PodeOAComponentRequestBody [-Name] <String> [-ContentSchemas] <Hashtable> [[-Description] <String>]
[-Required] [<CommonParameters>]
DESCRIPTION
Adds a reusable component for a request body.
EXAMPLES
EXAMPLE 1
Add-PodeOAComponentRequestBody -Name 'UserIdBody' -ContentSchemas @{ 'application/json' = (New-PodeOAIntProperty -Name 'userId' -Object) }
EXAMPLE 2
Add-PodeOAComponentRequestBody -Name 'UserIdBody' -ContentSchemas @{ 'application/json' = 'UserIdSchema' }
PARAMETERS
-ContentSchemas
The content-types and schema the request body accepts (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
-Description
A Description of the request body.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The reference Name of the request body.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Required
If supplied, the request body will be flagged as required.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.