Add PodeOAComponentResponse - mdaneri/Pode GitHub Wiki
external help file: Pode-help.xml Module Name: Pode online version: https://swagger.io/docs/specification/basic-structure/ PodeType: OAComponents schema: 2.0.0
Adds a reusable component for responses.
Add-PodeOAComponentResponse -Name <String> [-Content <Hashtable>] [-Headers <Object>] [-Description <String>]
[-Links <OrderedDictionary>] [-DefinitionTag <String[]>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Add-PodeOAComponentResponse -Name <String> -Reference <String> [-DefinitionTag <String[]>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Adds a reusable component for responses.
Add-PodeOAComponentResponse -Name 'OKResponse' -Content @{ 'application/json' = (New-PodeOAIntProperty -Name 'userId' -Object) }
Add-PodeOAComponentResponse -Name 'ErrorResponse' -Content @{ 'application/json' = 'ErrorSchema' }
The content-types and schema the response returns (the schema is created using the Property functions).
Type: Hashtable
Parameter Sets: Schema
Aliases: ContentSchemas
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAn Array of strings representing the unique tag for the API specification. This tag helps in distinguishing between different versions or types of API specifications within the application. You can use this tag to reference the specific API documentation, schema, or version that your function interacts with.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Description of the response.
Type: String
Parameter Sets: Schema
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe header name and schema the response returns (the schema is created using the Add-PodeOAComponentHeader cmdlet).
Type: Object
Parameter Sets: Schema
Aliases: HeaderSchemas
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA Response link definition
Type: OrderedDictionary
Parameter Sets: Schema
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe reference Name of the response.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA Reference Name of an existing component response to use.
Type: String
Parameter Sets: Reference
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
https://swagger.io/docs/specification/basic-structure/