SS.PowerShell

1.0.2.0

SS.PowerShell.dll-Help.xml

                                <?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`1 -->

      <command:returnValue>

        <dev:type>

          <maml:name>SS.PowerShell.SchemaTestResult`1[[Newtonsoft.Json.Schema.ValidationError, Newtonsoft.Json.Schema, Version=3.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed]]</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>

  <!-- Cmdlet: Test-XmlSchema -->

  <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-XmlSchema</command:name>

      <command:verb>Test</command:verb>

      <command:noun>XmlSchema</command:noun>

      <maml:description>

        <maml:para>Determines whether the XML file is valid.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Determines whether the XML file is valid.</maml:para>

    </maml:description>

    <command:syntax>

      <!-- Parameter set: __AllParameterSets -->

      <command:syntaxItem>

        <maml:name>Test-XmlSchema</maml:name>

        <!-- Parameter: SchemaFile -->

        <command:parameter required="true" globbing="false" pipelineInput="false" position="0">

          <maml:name>SchemaFile</maml:name>

          <maml:description>

            <maml:para>The XSD 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: XmlFile -->

        <command:parameter required="true" globbing="false" pipelineInput="false" position="1">

          <maml:name>XmlFile</maml:name>

          <maml:description>

            <maml:para>The source XML 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 XML 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 XSD 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: XmlFile -->

      <command:parameter required="true" globbing="false" pipelineInput="false" position="1">

        <maml:name>XmlFile</maml:name>

        <maml:description>

          <maml:para>The source XML 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 XML 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`1 -->

      <command:returnValue>

        <dev:type>

          <maml:name>SS.PowerShell.SchemaTestResult`1[[System.Exception, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</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-XmlSchema schema.xsd source.xml</dev:code>

      </command:example>

      <command:example>

        <maml:title>----------  EXAMPLE 2  ----------</maml:title>

        <dev:code>Test-XmlSchema schema.xsd source.xml UTF8</dev:code>

      </command:example>

    </command:examples>

  </command:command>

</helpItems>