New-PodeOAComponentSchemaProperty
SYNOPSIS
Creates a OpenAPI schema reference property.
SYNTAX
Inbuilt (Default)
New-PodeOAComponentSchemaProperty [-ParamsList <Hashtable[]>] [-Name <String>] -Reference <String>
[-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Array
New-PodeOAComponentSchemaProperty [-ParamsList <Hashtable[]>] [-Name <String>] -Reference <String>
[-Description <String>] [-XmlName <String>] [-XmlNamespace <String>] [-XmlPrefix <String>] [-XmlAttribute]
[-XmlItemName <String>] [-XmlWrapped] [-Example <Object>] [-Deprecated] [-Required] [-Nullable] [-ReadOnly]
[-WriteOnly] [-MinProperties <Int32>] [-MaxProperties <Int32>] [-Array] [-UniqueItems] [-MinItems <Int32>]
[-MaxItems <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Creates a new OpenAPI component schema reference from another OpenAPI schema.
EXAMPLES
EXAMPLE 1
New-PodeOAComponentSchemaProperty -Name 'Config' -Component "MyConfigSchema"
PARAMETERS
-Array
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: False
-Deprecated
If supplied, the schema will be treated as Deprecated where supported.
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Description
A Description of the property.
Type: String
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Example
An example of a parameter value
Type: Object
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxItems
If 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: False
-MaxProperties
If supplied, will restrict the maximum number of properties allowed in an schema.
Type: Int32
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-MinItems
If 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: False
-MinProperties
If supplied, will restrict the minimun number of properties allowed in an schema.
Type: Int32
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Name
The Name of the property.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Nullable
If supplied, the schema will be treated as Nullable.
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ParamsList
Used 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
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReadOnly
If supplied, the schema will be included in a response but not in a request
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Reference
An component schema name.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Required
If supplied, the object will be treated as Required where supported.
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-UniqueItems
If 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: False
-WriteOnly
If supplied, the schema will be included in a request but not in a response
Type: SwitchParameter
Parameter Sets: Array
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-XmlAttribute
Indicates 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: False
-XmlItemName
Specifically 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: False
-XmlName
By 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: False
-XmlNamespace
Defines 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: False
-XmlPrefix
Sets 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: False
-XmlWrapped
Indicates 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: 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.