Skip to content

Commit 6af0eb1

Browse files
StartAutomatingStartAutomating
authored andcommitted
Join-PipeScript: Improving Unnamed end block behavior (Fixes #363)
1 parent 46013db commit 6af0eb1

1 file changed

Lines changed: 41 additions & 35 deletions

File tree

docs/JSONSchema.Protocol.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
JSONSchema.Protocol
22
-------------------
3+
4+
5+
6+
37
### Synopsis
48
json schema protocol
59

10+
11+
612
---
13+
14+
715
### Description
816

917
Converts a json schema to PowerShell.
1018

19+
20+
1121
---
22+
23+
1224
### Examples
1325
#### EXAMPLE 1
1426
```PowerShell
@@ -23,132 +35,126 @@ jsonschema https://aka.ms/terminal-profiles-schema#/$defs/Profile
2335
}.Transpile()
2436
```
2537

38+
39+
2640
---
41+
42+
2743
### Parameters
2844
#### **SchemaUri**
2945

3046
The URI.
3147

3248

3349

34-
> **Type**: ```[Uri]```
3550

36-
> **Required**: true
3751

38-
> **Position**: named
3952

40-
> **PipelineInput**:false
53+
|Type |Required|Position|PipelineInput|
54+
|-------|--------|--------|-------------|
55+
|`[Uri]`|true |named |false |
4156

4257

4358

44-
---
4559
#### **CommandAst**
4660

4761
The Command's Abstract Syntax Tree
4862

4963

5064

51-
> **Type**: ```[CommandAst]```
5265

53-
> **Required**: true
5466

55-
> **Position**: named
5667

57-
> **PipelineInput**:false
68+
|Type |Required|Position|PipelineInput|
69+
|--------------|--------|--------|-------------|
70+
|`[CommandAst]`|true |named |false |
5871

5972

6073

61-
---
6274
#### **ScriptBlock**
6375

64-
> **Type**: ```[ScriptBlock]```
6576

66-
> **Required**: true
6777

68-
> **Position**: named
6978

70-
> **PipelineInput**:true (ByValue)
79+
|Type |Required|Position|PipelineInput |
80+
|---------------|--------|--------|--------------|
81+
|`[ScriptBlock]`|true |named |true (ByValue)|
7182

7283

7384

74-
---
7585
#### **RemovePropertyPrefix**
7686

7787
One or more property prefixes to remove.
7888
Properties that start with this prefix will become parameters without the prefix.
7989

8090

8191

82-
> **Type**: ```[String[]]```
8392

84-
> **Required**: false
8593

86-
> **Position**: named
8794

88-
> **PipelineInput**:false
95+
|Type |Required|Position|PipelineInput|Aliases |
96+
|------------|--------|--------|-------------|----------------------|
97+
|`[String[]]`|false |named |false |Remove Property Prefix|
8998

9099

91100

92-
---
93101
#### **ExcludeProperty**
94102

95103
One or more properties to ignore.
96104
Properties whose name or description is like this keyword will be ignored.
97105

98106

99107

100-
> **Type**: ```[String[]]```
101108

102-
> **Required**: false
103109

104-
> **Position**: named
105110

106-
> **PipelineInput**:false
111+
|Type |Required|Position|PipelineInput|Aliases |
112+
|------------|--------|--------|-------------|---------------------------------------------------------------------|
113+
|`[String[]]`|false |named |false |Ignore Property<br/>IgnoreProperty<br/>SkipProperty<br/>Skip Property|
107114

108115

109116

110-
---
111117
#### **IncludeProperty**
112118

113119
One or more properties to include.
114120
Properties whose name or description is like this keyword will be included.
115121

116122

117123

118-
> **Type**: ```[String[]]```
119124

120-
> **Required**: false
121125

122-
> **Position**: named
123126

124-
> **PipelineInput**:false
127+
|Type |Required|Position|PipelineInput|Aliases |
128+
|------------|--------|--------|-------------|----------------|
129+
|`[String[]]`|false |named |false |Include Property|
125130

126131

127132

128-
---
129133
#### **NoMandatory**
130134

131135
If set, will not mark a parameter as required, even if the schema indicates it should be.
132136

133137

134138

135-
> **Type**: ```[Switch]```
136139

137-
> **Required**: false
138140

139-
> **Position**: named
140141

141-
> **PipelineInput**:false
142+
|Type |Required|Position|PipelineInput|Aliases |
143+
|----------|--------|--------|-------------|--------------------------------------------------------------------------------------|
144+
|`[Switch]`|false |named |false |NoMandatoryParameters<br/>No Mandatory Parameters<br/>NoMandatories<br/>No Mandatories|
145+
146+
142147

143148

144149

145150
---
151+
152+
146153
### Syntax
147154
```PowerShell
148155
JSONSchema.Protocol -SchemaUri <Uri> -ScriptBlock <ScriptBlock> [-RemovePropertyPrefix <String[]>] [-ExcludeProperty <String[]>] [-IncludeProperty <String[]>] [-NoMandatory] [<CommonParameters>]
149156
```
150157
```PowerShell
151158
JSONSchema.Protocol -SchemaUri <Uri> -CommandAst <CommandAst> [-RemovePropertyPrefix <String[]>] [-ExcludeProperty <String[]>] [-IncludeProperty <String[]>] [-NoMandatory] [<CommonParameters>]
152159
```
153-
---
154160

0 commit comments

Comments
 (0)