Push v1.0.0 Module

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+All changes to this module should be reflected in this document.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## [1.0.0] - 2020-09-09
+### Added
+- Updated documentation and external help
+- CHNAGELOG added
+- psakefile added
+
+### Changed
+- README
+- Definition File updated with URLs and new version
+
+### Fixed
+- Missing some JSON data types, bool and int
+- Write-Verbose acts different for arrays, so corrected the output
+
+## [0.0.1] - 2020-09-08
+### Added
+- Repository Created
+- Module manifest created
+- Module file copied from outside repository
+- Updated psd with defaultprefix and privatedata
+- Added help and about help
+- Converted functions to leverage the PowerShell Pipeline
+- Removed New-RootDocument function
+- Updated Schema param to be SchemaDocument

docs/Get-SchemaArray.md

@@ -8,30 +8,37 @@ schema: 2.0.0
 # Get-SchemaArray
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+This function returns the object from an array within the Json Schema.
 
 ## SYNTAX
 
 ```
-Get-SchemaArray [[-Schema] <Object>]
+Get-SchemaArray [[-SchemaDocument] <Object>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+This function returns the object from an array within the Json Schema. This function expands the array and returns a
+PowerShell representation of the object.
 
 ## EXAMPLES
 
 ### Example 1
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> $SchemaDocument = 'https://gist.githubusercontent.com/jeffpatton1971/c2d3ee98a37766a2784ccd626b9b8ca2/raw/f2a92166f52e067542964216a7618b8d2c408489/array.json' |Get-SchemaDocument
+PS C:\> $SchemaDocument.properties.products |Get-SchemaArray
+
+price dimensions tags name
+----- ---------- ---- ----
+    0            {}
 ```
 
-{{ Add example description here }}
+This example reads in a Json schema from the internet and then passes in a specific array item within the schema.
 
 ## PARAMETERS
 
-### -Schema
-{{ Fill Schema Description }}
+### -SchemaDocument
+This should be the output of Get-SchemaDocument. For simple JSON schema's this could be passed along the pipeline
+to this function.
 
 ```yaml
 Type: Object
@@ -41,17 +48,22 @@ Aliases:
 Required: False
 Position: 0
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-## INPUTS
+### 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](http://go.microsoft.com/fwlink/?LinkID=113216).
 
-### None
+## INPUTS
+### System.Object
+This should always be the output of the Get-SchemaDocument function.
 
 ## OUTPUTS
-
 ### System.Object
+A PowerShell representation of the referenced schema
+
 ## NOTES
 
 ## RELATED LINKS
+[Get-SchemaDocument](https://github.com/SchemaModule/PowerShell/blob/master/docs/Get-SchemaDocument.md#get-schemadocument)

docs/Get-SchemaDocument.md

@@ -8,30 +8,59 @@ schema: 2.0.0
 # Get-SchemaDocument
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+This function will return a PowerShell object of the input Schema.
 
 ## SYNTAX
 
 ```
-Get-SchemaDocument [[-Path] <String>]
+Get-SchemaDocument [[-Path] <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+This function will return a PowerShell object of the input Schema. This will help in building PowerShell objects
+that can be defined by a JSON schema. This allows a script to dynamically build objects based on a well-defined
+JSON schema.
 
 ## EXAMPLES
 
 ### Example 1
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> 'https://gist.githubusercontent.com/jeffpatton1971/c2d3ee98a37766a2784ccd626b9b8ca2/raw/a112c9119cce507c2b4e115c35afc6c26f63ffc7/schema.json' |Get-SchemaDocument
+
+
+$schema     : http://json-schema.org/draft-07/schema
+$id         : http://example.com/root.json
+type        : object
+title       : The Root Schema
+description : The root schema is the schema that comprises the entire JSON document.
+default     :
+required    : {checked, dimensions, id, name...}
+properties  : @{checked=; dimensions=; id=; name=; price=; tags=}
+```
+
+This example demonstrates passing a URL along the pipeline to the function.
+
+### Example 2
+```powershell
+PS C:\> Get-SchemaDocument -Path D:\CODE\JSON\schema.json
+
+
+$schema     : http://json-schema.org/draft-07/schema
+$id         : http://example.com/root.json
+type        : object
+title       : The Root Schema
+description : The root schema is the schema that comprises the entire JSON document.
+default     :
+required    : {checked, dimensions, id, name...}
+properties  : @{checked=; dimensions=; id=; name=; price=; tags=}
 ```
 
-{{ Add example description here }}
+This example passes a json schema file into the function.
 
 ## PARAMETERS
 
 ### -Path
-{{ Fill Path Description }}
+This can be a filepath or URL, the function does light validation on the input.
 
 ```yaml
 Type: String
@@ -41,17 +70,22 @@ Aliases:
 Required: False
 Position: 0
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-## INPUTS
+### 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](http://go.microsoft.com/fwlink/?LinkID=113216).
 
-### None
+## INPUTS
+### System.String
+A local or remote Json Schema file as defined by json-schema.org
 
 ## OUTPUTS
-
 ### System.Object
+A PowerShell object representing the corresponding Json Schema
+
 ## NOTES
 
 ## RELATED LINKS
+[https://json-schema.org/](Json Schema Organization)

docs/Get-SchemaObject.md

@@ -8,30 +8,47 @@ schema: 2.0.0
 # Get-SchemaObject
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+This function returns an object from the Json Schema.
 
 ## SYNTAX
 
 ```
-Get-SchemaObject [[-Schema] <Object>]
+Get-SchemaObject [[-SchemaDocument] <Object>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+This function returns an object from the Json Schema. By passing in a specific data structure and get back a
+PowerShell representation of the structure.
 
 ## EXAMPLES
 
 ### Example 1
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> Get-SchemaObject -SchemaDocument $SchemaDocument
+
+price dimensions tags name
+----- ---------- ---- ----
+    0            {}
+```
+
+This example shows how to pass in an object to the function.
+
+### Example 2
+```powershell
+PS C:\> 'https://gist.githubusercontent.com/jeffpatton1971/c2d3ee98a37766a2784ccd626b9b8ca2/raw/a112c9119cce507c2b4e115c35afc6c26f63ffc7/schema.json' |Get-SchemaDocument |Get-SchemaObject
+
+price dimensions tags name
+----- ---------- ---- ----
+    0            {}
 ```
 
-{{ Add example description here }}
+A slightly more complex example, showing the ability to pass the schema along the pipeline to other functions.
 
 ## PARAMETERS
 
-### -Schema
-{{ Fill Schema Description }}
+### -SchemaDocument
+This should be the output of Get-SchemaDocument. For simple JSON schema's this could be passed along the pipeline
+to this function.
 
 ```yaml
 Type: Object
@@ -41,17 +58,22 @@ Aliases:
 Required: False
 Position: 0
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-## INPUTS
+### 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](http://go.microsoft.com/fwlink/?LinkID=113216).
 
-### None
+## INPUTS
+### System.Object
+This should always be the output of the Get-SchemaDocument function.
 
 ## OUTPUTS
-
 ### System.Object
+A PowerShell representation of the referenced schema
+
 ## NOTES
 
 ## RELATED LINKS
+[Get-SchemaDocument](https://github.com/SchemaModule/PowerShell/blob/master/docs/Get-SchemaDocument.md#get-schemadocument)

docs/Get-SchemaProperty.md

@@ -8,30 +8,58 @@ schema: 2.0.0
 # Get-SchemaProperty
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+This function returns one ore more properties from a Json Schema object.
 
 ## SYNTAX
 
 ```
-Get-SchemaProperty [[-Schema] <Object>] [[-Name] <String>]
+Get-SchemaProperty [[-SchemaDocument] <Object>] [[-Name] <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+This function returns one ore more properties from a Json Schema object. This will allow you to view the detailed
+information of a given property from the Schema.
 
 ## EXAMPLES
 
 ### Example 1
 ```powershell
-PS C:\> {{ Add example code here }}
+PS C:\> $SchemaDocument.properties.products.items.anyOf |Get-SchemaProperty
+
+
+checked    : @{$id=#/properties/products/items/anyOf/0/properties/checked; type=boolean; title=The checked schema; description=An explanation about the purpose of this instance.; default=False; examples=System.Object[]}
+dimensions : @{$id=#/properties/products/items/anyOf/0/properties/dimensions; type=object; title=The dimensions schema; description=An explanation about the purpose of this instance.; default=; examples=System.Object[]; required=System.Object[]; properties=;
+             additionalProperties=True}
+id         : @{$id=#/properties/products/items/anyOf/0/properties/id; type=integer; title=The id schema; description=An explanation about the purpose of this instance.; default=0; examples=System.Object[]}
+name       : @{$id=#/properties/products/items/anyOf/0/properties/name; type=string; title=The name schema; description=An explanation about the purpose of this instance.; default=; examples=System.Object[]}
+price      : @{$id=#/properties/products/items/anyOf/0/properties/price; type=number; title=The price schema; description=An explanation about the purpose of this instance.; default=0.0; examples=System.Object[]}
+tags       : @{$id=#/properties/products/items/anyOf/0/properties/tags; type=array; title=The tags schema; description=An explanation about the purpose of this instance.; default=System.Object[]; examples=System.Object[]; additionalItems=True; items=}
+```
+
+This example passes the schema object along the pipeline and returns all properties.
+
+### Example 2
+```powershell
+PS C:\> Get-SchemaProperty -SchemaDocument $SchemaDocument.properties.products.items.anyOf -Name dimensions
+
+
+$id                  : #/properties/products/items/anyOf/0/properties/dimensions
+type                 : object
+title                : The dimensions schema
+description          : An explanation about the purpose of this instance.
+default              :
+examples             : {@{width=5; height=10}}
+required             : {width, height}
+properties           : @{width=; height=}
+additionalProperties : True
 ```
 
-{{ Add example description here }}
+This example passes the Schema into the function and references a specific named property to return.
 
 ## PARAMETERS
 
 ### -Name
-{{ Fill Name Description }}
+The name of a property to return
 
 ```yaml
 Type: String
@@ -45,8 +73,9 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Schema
-{{ Fill Schema Description }}
+### -SchemaDocument
+This should be the output of Get-SchemaDocument. For simple JSON schema's this could be passed along the pipeline
+to this function.
 
 ```yaml
 Type: Object
@@ -56,17 +85,22 @@ Aliases:
 Required: False
 Position: 0
 Default value: None
-Accept pipeline input: False
+Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-## INPUTS
+### 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](http://go.microsoft.com/fwlink/?LinkID=113216).
 
-### None
+## INPUTS
+### System.Object
+This should always be the output of the Get-SchemaDocument function.
 
 ## OUTPUTS
-
 ### System.Object
+A PowerShell representation of the referenced schema
+
 ## NOTES
 
 ## RELATED LINKS
+[Get-SchemaDocument](https://github.com/SchemaModule/PowerShell/blob/master/docs/Get-SchemaDocument.md#get-schemadocument)