Skip to content

Add-PodeOAComponentResponse

SYNOPSIS

Adds a reusable component for responses.

SYNTAX

Add-PodeOAComponentResponse [-Name] <String> [[-ContentSchemas] <Hashtable>] [[-HeaderSchemas] <Hashtable>]
 [-Description] <String> [<CommonParameters>]

DESCRIPTION

Adds a reusable component for responses.

EXAMPLES

EXAMPLE 1

Add-PodeOAComponentResponse -Name 'OKResponse' -ContentSchemas @{ 'application/json' = (New-PodeOAIntProperty -Name 'userId' -Object) }

EXAMPLE 2

Add-PodeOAComponentResponse -Name 'ErrorResponse' -ContentSchemas @{ 'application/json' = 'ErrorSchema' }

PARAMETERS

-ContentSchemas

The content-types and schema the response returns (the schema is created using the Property functions).

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Description

The Description of the response.

Type: String
Parameter Sets: (All)
Aliases:

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

-HeaderSchemas

The header name and schema the response returns (the schema is created using the Property functions).

Type: Hashtable
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 response.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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