-
Notifications
You must be signed in to change notification settings - Fork 0
New PodeOAComponentSchemaProperty
external help file: Pode-help.xml Module Name: Pode online version: https://swagger.io/docs/specification/basic-structure/ PodeType: OAProperties schema: 2.0.0
Creates a OpenAPI schema reference property.
New-PodeOAComponentSchemaProperty [-ParamsList <Hashtable[]>] [-Name <String>] -Reference <String>
[-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute] [-Example <Object>]
[-Deprecated] [-Required] [-Nullable] [-ReadOnly] [-WriteOnly] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
New-PodeOAComponentSchemaProperty [-ParamsList <Hashtable[]>] [-Name <String>] -Reference <String>
[-Description <String>] [-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute]
[-Example <Object>] [-Deprecated] [-Required] [-Nullable] [-ReadOnly] [-WriteOnly] [-XmlItemName <String>]
[-XmlWrapped] [-Array] [-UniqueItems] [-MinItems <Int32>] [-MaxItems <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Creates a new OpenAPI component schema reference from another OpenAPI schema.
New-PodeOAComponentSchemaProperty -Name 'Config' -Component "MyConfigSchema"
If supplied, the schema will be treated as an array of objects.
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the schema will be treated as Deprecated where supported.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseA Description of the property.
Type: String
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAn example of a parameter value
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, specify maximum length of an array
Type: Int32
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, specify minimum length of an array
Type: Int32
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseThe Name of the property.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the schema will be treated as Nullable.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseUsed to pipeline multiple properties
Type: Hashtable[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: FalseIf supplied, the schema will be included in a response but not in a request
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseAn component schema name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the object will be treated as Required where supported.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, specify that all items in the array must be unique
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the schema will be included in a request but not in a response
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether the property should be serialized as an XML attribute, equivalent to the 'xml.attribute' attribute in OpenAPI.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecifically for properties treated as arrays, it defines the XML name for each item in the array. This parameter aligns with the 'xml.name' attribute under 'items' in OpenAPI.
Type: String
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseBy default, XML elements get the same names that fields in the API declaration have. This property change the XML name of the property reflecting the 'xml.name' attribute in the OpenAPI specification.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDefines a specific XML namespace for the property, corresponding to the 'xml.namespace' attribute in OpenAPI.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSets a prefix for the XML element name, aligning with the 'xml.prefix' attribute in OpenAPI.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether array items should be wrapped in an XML element, similar to the 'xml.wrapped' attribute in OpenAPI.
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
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.
sss
x