New PodeOAStringProperty - mdaneri/Pode GitHub Wiki
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 new OpenAPI string property.
New-PodeOAStringProperty [[-ParamsList] <Hashtable[]>] [-Name <String>] [-Format <String>] [-Default <String>]
[-Pattern <String>] [-Description <String>] [-ExternalDoc <String>] [-Example <Object>] [-Enum <String[]>]
[-Required] [-Deprecated] [-Object] [-Nullable] [-ReadOnly] [-WriteOnly] [-MinLength <Int32>]
[-MaxLength <Int32>] [-NoAdditionalProperties] [-AdditionalProperties <Hashtable>] [-XmlName <String>]
[-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
New-PodeOAStringProperty [[-ParamsList] <Hashtable[]>] [-Name <String>] [-Format <String>]
[-CustomFormat <String>] [-Default <String>] [-Pattern <String>] [-Description <String>]
[-ExternalDoc <String>] [-Example <Object>] [-Enum <String[]>] [-Required] [-Deprecated] [-Object] [-Nullable]
[-ReadOnly] [-WriteOnly] [-MinLength <Int32>] [-MaxLength <Int32>] [-NoAdditionalProperties]
[-AdditionalProperties <Hashtable>] [-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>]
[-XmlAttribute] [-XmlItemName <String>] [-XmlWrapped] [-Array] [-UniqueItems] [-MinItems <Int32>]
[-MaxItems <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-PodeOAStringProperty [[-ParamsList] <Hashtable[]>] [-Name <String>] [-CustomFormat <String>]
[-Default <String>] [-Pattern <String>] [-Description <String>] [-ExternalDoc <String>] [-Example <Object>]
[-Enum <String[]>] [-Required] [-Deprecated] [-Object] [-Nullable] [-ReadOnly] [-WriteOnly]
[-MinLength <Int32>] [-MaxLength <Int32>] [-NoAdditionalProperties] [-AdditionalProperties <Hashtable>]
[-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Creates a new OpenAPI string property, for Schemas or Parameters.
New-PodeOAStringProperty -Name 'userType' -Default 'admin'
New-PodeOAStringProperty -Name 'password' -Format Password
Define a set of additional properties for the OpenAPI schema. This parameter accepts a HashTable where each key-value pair represents a property name and its corresponding schema. The schema for each property can include type, format, description, and other OpenAPI specification attributes. When specified, these additional properties are included in the OpenAPI definition, allowing for more flexible and dynamic object structures.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the object 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: FalseThe name of a custom OpenAPI Format of the string. (Default: None)
Type: String
Parameter Sets: Array, Custom
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe default value of the property. (Default: $null)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the string 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: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAn optional array of values that this property can only be set to.
Type: String[]
Parameter Sets: (All)
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, add an additional external documentation for this operation. The parameter is created by Add-PodeOAExternalDoc
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe inbuilt OpenAPI Format of the string. (Default: Any)
Type: String
Parameter Sets: Inbuilt, Array
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, the string will be restricted to maximal length of characters.
Type: Int32
Parameter Sets: (All)
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: FalseIf supplied, the string will be restricted to minimal length of characters.
Type: Int32
Parameter Sets: (All)
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: Title
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, will configure the OpenAPI property additionalProperties to false. This means that the defined object will not allow any properties beyond those explicitly declared in its schema. If any additional properties are provided, they will be considered invalid. Use this switch to enforce a strict schema definition, ensuring that objects contain only the specified set of properties and no others.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the string 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: FalseIf supplied, the string will be automatically wrapped in an object.
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: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseA Regex pattern that the string must match.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
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: FalseIf supplied, the string 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: FalseIf supplied, the string 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 string 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.