Skip to content

Commit ad2719d

Browse files
Task-57 : Updating documentatoin to reflect recent changes to module
1 parent 9b00879 commit ad2719d

17 files changed

+804
-342
lines changed

docs/ConvertFrom-SchemaArray.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,14 @@ Accept wildcard characters: False
102102
```
103103
104104
### CommonParameters
105-
106105
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).
107106
108107
## INPUTS
109108
110109
### None
111-
112110
## OUTPUTS
113111
114112
### System.Object[]
115-
116113
## NOTES
117114
118115
## RELATED LINKS

docs/ConvertFrom-SchemaObject.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,17 +115,14 @@ Accept wildcard characters: False
115115
```
116116
117117
### CommonParameters
118-
119118
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).
120119
121120
## INPUTS
122121
123122
### None
124-
125123
## OUTPUTS
126124
127125
### System.Object
128-
129126
## NOTES
130127
131128
## RELATED LINKS

docs/ConvertTo-SchemaElement.md

Lines changed: 23 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ SchemaModule classes.
1515
## SYNTAX
1616

1717
```
18-
ConvertTo-SchemaElement [-Object] <Object> [<CommonParameters>]
18+
ConvertTo-SchemaElement [-Object] <Object> [-IsRootSchema] [<CommonParameters>]
1919
```
2020

2121
## DESCRIPTION
@@ -71,6 +71,21 @@ Format-List CmdLet.
7171

7272
## PARAMETERS
7373

74+
### -IsRootSchema
75+
{{ Fill IsRootSchema Description }}
76+
77+
```yaml
78+
Type: System.Management.Automation.SwitchParameter
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
7489
### -Object
7590
7691
This is a JSON Schema object as defined by the json-schema.org (see related links
@@ -106,79 +121,33 @@ Accept wildcard characters: False
106121
```
107122
108123
### CommonParameters
109-
110124
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).
111125
112126
## INPUTS
113127
114128
### None
115-
116129
## OUTPUTS
117130
118131
### schemaDocument
119-
120-
This class is really modified object that contains the $schema attribute as well
121-
as validation on what values can be present for that attribute.
122-
123-
[Schema Object](https://json-schema.org/understanding-json-schema/reference/object.html)
124-
125-
[Schema Keyword](https://json-schema.org/understanding-json-schema/reference/schema.html)
126-
127-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
132+
This class is really modified object that contains the $schema attribute as well as validation on what values can be present for that attribute. Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Keyword (https://json-schema.org/understanding-json-schema/reference/schema.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
128133
129134
### schemaString
130-
131-
The string type is used for strings of text. It may contain Unicode characters.
132-
133-
[Schema String](https://json-schema.org/understanding-json-schema/reference/string.html)
134-
135-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
135+
The string type is used for strings of text. It may contain Unicode characters. Schema String (https://json-schema.org/understanding-json-schema/reference/string.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
136136
137137
### schemaInteger
138-
139-
The integer type is used for integral numbers. In PowerShell this is an int32
140-
141-
[Schema Integer](http://json-schema.org/understanding-json-schema/reference/numeric.html#integer)
142-
143-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
138+
The integer type is used for integral numbers. In PowerShell this is an int32 Schema Integer (http://json-schema.org/understanding-json-schema/reference/numeric.html#integer) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
144139
145140
### schemaNumber
146-
147-
The number type is used for any numeric type, either integers or floating point
148-
numbers. In PowerShell this is a double.
149-
150-
[Schema Number](http://json-schema.org/understanding-json-schema/reference/numeric.html#number)
151-
152-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
141+
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)
153142
154143
### schemaBoolean
155-
156-
The boolean type matches only two special values: true and false. Note that
157-
values that evaluate to true or false, such as 1 and 0, are not accepted by the
158-
schema.
159-
160-
[Schema Boolean](http://json-schema.org/understanding-json-schema/reference/boolean.html)
161-
162-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
144+
The boolean type matches only two special values: true and false. Note that values that evaluate to true or false, such as 1 and 0, are not accepted by the schema. Schema Boolean (http://json-schema.org/understanding-json-schema/reference/boolean.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
163145
164146
### schemaObject
165-
166-
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the
167-
"keys" must always be strings. Each of these pairs is conventionally referred
168-
to as a "property".
169-
170-
[Schema Object](https://json-schema.org/understanding-json-schema/reference/object.html)
171-
172-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
147+
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the "keys" must always be strings. Each of these pairs is conventionally referred to as a "property". Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
173148
174149
### schemaArray
175-
176-
Arrays are used for ordered elements. In JSON, each element in an array may be
177-
of a different type.
178-
179-
[Schema Array](https://json-schema.org/understanding-json-schema/reference/array.html)
180-
181-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
150+
Arrays are used for ordered elements. In JSON, each element in an array may be of a different type. Schema Array (https://json-schema.org/understanding-json-schema/reference/array.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
182151
183152
## NOTES
184153

docs/Find-SchemaElement.md

Lines changed: 31 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,24 @@ by Name, by Type or by a Path.
1414

1515
## SYNTAX
1616

17-
### path
17+
### definitions
18+
```
19+
Find-SchemaElement -Schema <Object> [-ElementName <String>] [-IsDefinition] [<CommonParameters>]
20+
```
1821

22+
### path
1923
```
20-
Find-SchemaElement -Schema <Object> [-ElementPath <Object>] [<CommonParameters>]
24+
Find-SchemaElement -Schema <Object> [-ElementPath <String>] [<CommonParameters>]
2125
```
2226

2327
### type
24-
2528
```
26-
Find-SchemaElement -Schema <Object> [-ElementType <Object>] [<CommonParameters>]
29+
Find-SchemaElement -Schema <Object> [-ElementType <String>] [<CommonParameters>]
2730
```
2831

2932
### name
30-
3133
```
32-
Find-SchemaElement -Schema <Object> [-ElementName <Object>] [<CommonParameters>]
34+
Find-SchemaElement -Schema <Object> [-ElementName <String>] [<CommonParameters>]
3335
```
3436

3537
## DESCRIPTION
@@ -135,7 +137,7 @@ The name of the property, object or array that we are looking for
135137

136138
```yaml
137139
Type: System.String
138-
Parameter Sets: name
140+
Parameter Sets: definitions, name
139141
Aliases:
140142

141143
Required: False
@@ -179,6 +181,21 @@ Accept pipeline input: False
179181
Accept wildcard characters: False
180182
```
181183
184+
### -IsDefinition
185+
{{ Fill IsDefinition Description }}
186+
187+
```yaml
188+
Type: System.Management.Automation.SwitchParameter
189+
Parameter Sets: definitions
190+
Aliases:
191+
192+
Required: True
193+
Position: Named
194+
Default value: None
195+
Accept pipeline input: False
196+
Accept wildcard characters: False
197+
```
198+
182199
### -Schema
183200
184201
The schema that we are searching through
@@ -196,79 +213,33 @@ Accept wildcard characters: False
196213
```
197214
198215
### CommonParameters
199-
200216
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).
201217
202218
## INPUTS
203219
204220
### None
205-
206221
## OUTPUTS
207222
208223
### schemaDocument
209-
210-
This class is really modified object that contains the $schema attribute as well
211-
as validation on what values can be present for that attribute.
212-
213-
[Schema Object](https://json-schema.org/understanding-json-schema/reference/object.html)
214-
215-
[Schema Keyword](https://json-schema.org/understanding-json-schema/reference/schema.html)
216-
217-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
224+
This class is really modified object that contains the $schema attribute as well as validation on what values can be present for that attribute. Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Keyword (https://json-schema.org/understanding-json-schema/reference/schema.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
218225
219226
### schemaString
220-
221-
The string type is used for strings of text. It may contain Unicode characters.
222-
223-
[Schema String](https://json-schema.org/understanding-json-schema/reference/string.html)
224-
225-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
227+
The string type is used for strings of text. It may contain Unicode characters. Schema String (https://json-schema.org/understanding-json-schema/reference/string.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
226228
227229
### schemaInteger
228-
229-
The integer type is used for integral numbers. In PowerShell this is an int32
230-
231-
[Schema Integer](http://json-schema.org/understanding-json-schema/reference/numeric.html#integer)
232-
233-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
230+
The integer type is used for integral numbers. In PowerShell this is an int32 Schema Integer (http://json-schema.org/understanding-json-schema/reference/numeric.html#integer) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
234231
235232
### schemaNumber
236-
237-
The number type is used for any numeric type, either integers or floating point
238-
numbers. In PowerShell this is a double.
239-
240-
[Schema Number](http://json-schema.org/understanding-json-schema/reference/numeric.html#number)
241-
242-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
233+
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)
243234
244235
### schemaBoolean
245-
246-
The boolean type matches only two special values: true and false. Note that
247-
values that evaluate to true or false, such as 1 and 0, are not accepted by the
248-
schema.
249-
250-
[Schema Boolean](http://json-schema.org/understanding-json-schema/reference/boolean.html)
251-
252-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
236+
The boolean type matches only two special values: true and false. Note that values that evaluate to true or false, such as 1 and 0, are not accepted by the schema. Schema Boolean (http://json-schema.org/understanding-json-schema/reference/boolean.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
253237
254238
### schemaObject
255-
256-
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the
257-
"keys" must always be strings. Each of these pairs is conventionally referred
258-
to as a "property".
259-
260-
[Schema Object](https://json-schema.org/understanding-json-schema/reference/object.html)
261-
262-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
239+
Objects are the mapping type in JSON. They map "keys" to "values". In JSON, the "keys" must always be strings. Each of these pairs is conventionally referred to as a "property". Schema Object (https://json-schema.org/understanding-json-schema/reference/object.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
263240
264241
### schemaArray
265-
266-
Arrays are used for ordered elements. In JSON, each element in an array may be
267-
of a different type.
268-
269-
[Schema Array](https://json-schema.org/understanding-json-schema/reference/array.html)
270-
271-
[Schema Types](https://json-schema.org/understanding-json-schema/reference/type.html)
242+
Arrays are used for ordered elements. In JSON, each element in an array may be of a different type. Schema Array (https://json-schema.org/understanding-json-schema/reference/array.html) Schema Types (https://json-schema.org/understanding-json-schema/reference/type.html)
272243
273244
## NOTES
274245

docs/Format-SchemaDocument.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,14 @@ Accept wildcard characters: False
8282
```
8383
8484
### CommonParameters
85-
8685
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).
8786
8887
## INPUTS
8988
9089
### System.String
91-
9290
## OUTPUTS
9391
9492
### System.String
95-
9693
## NOTES
9794
9895
## RELATED LINKS

0 commit comments

Comments
 (0)