SS.PowerShell

1.0.1.0

SS.PowerShell.dll-Help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 <?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Test-JsonSchema -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Test-JsonSchema</command:name>
      <command:verb>Test</command:verb>
      <command:noun>JsonSchema</command:noun>
      <maml:description>
        <maml:para>Determines whether the JSON file is valid.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Determines whether the JSON file is valid.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Test-JsonSchema</maml:name>
        <!-- Parameter: SchemaFile -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
          <maml:name>SchemaFile</maml:name>
          <maml:description>
            <maml:para>The JSON schema file to test against.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: JsonFile -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="1">
          <maml:name>JsonFile</maml:name>
          <maml:description>
            <maml:para>The source JSON file to test.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Encoding -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
          <maml:name>Encoding</maml:name>
          <maml:description>
            <maml:para>Encoding type to use when reading schema and JSON file.</maml:para>
            <maml:para>Possible values: Default, ASCII, BigEndianUnicode, Unicode, UTF32, UTF7, UTF8</maml:para>
          </maml:description>
          <command:parameterValue required="true">EncodingType</command:parameterValue>
          <dev:type>
            <maml:name>SS.PowerShell.EncodingType</maml:name>
            <maml:uri />
            <maml:description>
              <maml:para>Types of text encoding to use when reading content.</maml:para>
            </maml:description>
          </dev:type>
          <dev:defaultValue>Default</dev:defaultValue>
          <command:parameterValueGroup>
            <command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">ASCII</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">BigEndianUnicode</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Unicode</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">UTF32</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">UTF7</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">UTF8</command:parameterValue>
          </command:parameterValueGroup>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: SchemaFile -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="0">
        <maml:name>SchemaFile</maml:name>
        <maml:description>
          <maml:para>The JSON schema file to test against.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: JsonFile -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="1">
        <maml:name>JsonFile</maml:name>
        <maml:description>
          <maml:para>The source JSON file to test.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Encoding -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
        <maml:name>Encoding</maml:name>
        <maml:description>
          <maml:para>Encoding type to use when reading schema and JSON file.</maml:para>
          <maml:para>Possible values: Default, ASCII, BigEndianUnicode, Unicode, UTF32, UTF7, UTF8</maml:para>
        </maml:description>
        <command:parameterValue required="true">EncodingType</command:parameterValue>
        <dev:type>
          <maml:name>SS.PowerShell.EncodingType</maml:name>
          <maml:uri />
          <maml:description>
            <maml:para>Types of text encoding to use when reading content.</maml:para>
          </maml:description>
        </dev:type>
        <dev:defaultValue>Default</dev:defaultValue>
        <command:parameterValueGroup>
          <command:parameterValue required="false" variableLength="false">Default</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">ASCII</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">BigEndianUnicode</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Unicode</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">UTF32</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">UTF7</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">UTF8</command:parameterValue>
        </command:parameterValueGroup>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <!-- OutputType: SchemaTestResult -->
      <command:returnValue>
        <dev:type>
          <maml:name>SS.PowerShell.SchemaTestResult</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>Result object that is returned from schema test.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <dev:code>Test-JsonSchema schema.json source.json</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 2 ----------</maml:title>
        <dev:code>Test-JsonSchema schema.json source.json UTF8</dev:code>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>