Skip to content

Commit 3d8718b

Browse files
issue-44 : Updating help ahead of release
1 parent 0d628c5 commit 3d8718b

File tree

3 files changed

+20
-7
lines changed

3 files changed

+20
-7
lines changed

docs/ConvertTo-SchemaDefinition.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ schemaDefinition class or a json string.
1616
## SYNTAX
1717

1818
```
19-
ConvertTo-SchemaDefinition [[-Definition] <Object>] [-AsJson] [<CommonParameters>]
19+
ConvertTo-SchemaDefinition [[-Definition] <Object>] [-AsJson] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
@@ -43,7 +43,6 @@ required :
4343
This example shows how to use the function to convert an object into a schema
4444
class.
4545

46-
4746
## PARAMETERS
4847

4948
### -AsJson
@@ -94,10 +93,10 @@ Type: System.Object
9493
Parameter Sets: (All)
9594
Aliases:
9695

97-
Required: True
96+
Required: False
9897
Position: 0
9998
Default value: None
100-
Accept pipeline input: False
99+
Accept pipeline input: True (ByValue)
101100
Accept wildcard characters: False
102101
```
103102

docs/Get-SchemaDocument.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This function will return a schemaDocument object of the input Schema.
1414
## SYNTAX
1515

1616
```
17-
Get-SchemaDocument [[-Path] <String>] [<CommonParameters>]
17+
Get-SchemaDocument [[-Path] <String>] [-Headers <Hashtable>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -63,6 +63,22 @@ This example passes a json schema file into the function.
6363

6464
## PARAMETERS
6565

66+
### -Headers
67+
68+
This should be a hashtable of key/value pairs that the server is expecting.
69+
70+
```yaml
71+
Type: System.Collections.Hashtable
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
6682
### -Path
6783
6884
This can be a filepath or URL, the function does light validation on the input.

docs/New-SchemaBoolean.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
165165
## INPUTS
166166
167167
### None
168-
169168
## OUTPUTS
170169
171170
### schemaBoolean
172-
173171
## NOTES
174172
175173
## RELATED LINKS

0 commit comments

Comments
 (0)