Add PodeOAComponentHeader - 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 a Header schema.
Add-PodeOAComponentHeader -Name <String> [-Description <String>] [-Schema] <Hashtable>
[-DefinitionTag <String[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Adds a reusable component for a Header schema.
Add-PodeOAComponentHeader -Name 'UserIdSchema' -Schema (New-PodeOAIntProperty -Name 'userId' -Object)
An 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: FalseA description of the header
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe reference Name of the schema.
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: FalseThe Schema definition (the schema is created using the Property functions).
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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/
https://swagger.io/docs/specification/data-models/