Skip to content

Latest commit

 

History

History
285 lines (212 loc) · 6.16 KB

New-SchemaNumber.md

File metadata and controls

285 lines (212 loc) · 6.16 KB
external help file Module Name online version schema
schema-help.xml
schema
2.0.0

New-SchemaNumber

SYNOPSIS

A function to create new Schema Number object

SYNTAX

New-SchemaNumber [-id <String>] [-ref <String>] [-minimum <Decimal>] [-maximum <Decimal>]
 [-exclusiveMinimum <Decimal>] [-exclusiveMaximum <Decimal>] [-multipleOf <Decimal>] [-title <String>]
 [-description <String>] [-default <Decimal>] [-examples <Decimal[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

A function to create new Schema Number object

EXAMPLES

Example 1

New-SchemaNumber -title Temp -description "Default temperature for the room" -default 72.3


$id         :
title       : Temp
description : Default temperature for the room
default     : 72.3

A simple example of usage

PARAMETERS

-default

The default keyword specifies a default value for an item.

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-description

The title and description keywords must be strings. A "description" will provide a more lengthy explanation about the purpose of the data described by the schema

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-examples

The examples keyword is a place to provide an array of examples that validate against the schema.

Type: System.Decimal[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-exclusiveMaximum

Ranges of numbers are specified using a combination of the minimum and maximum keywords, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range).

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-exclusiveMinimum

Ranges of numbers are specified using a combination of the minimum and maximum keywords, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range).

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

The $id property is a URI-reference that serves two purposes, it declares a unique identifier for the schema and it declares a base URI against which $ref URI-references are resolved.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-maximum

Ranges of numbers are specified using a combination of the minimum and maximum keywords, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range).

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-minimum

Ranges of numbers are specified using a combination of the minimum and maximum keywords, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range).

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-multipleOf

Numbers can be restricted to a multiple of a given number, using the multipleOf keyword.

Type: System.Decimal
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ref

The $id property is a URI-reference that serves two purposes, it declares a unique identifier for the schema and it declares a base URI against which $ref URI-references are resolved.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-title

The title and description keywords must be strings. A "title" will preferably be short explanation about the purpose of the data described by the schema.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
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.

INPUTS

None

OUTPUTS

schemaNumber

The number type is used for any numeric type, either integers or floating point numbers. In PowerShell this is a double. Schema Number (http://json-schema.org/understanding-json-schema/reference/numeric.html#number) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)

NOTES

RELATED LINKS

New-SchemaElement

About Classes

JSON Schema Reference