Get-PSGoodFirstIssue

0.0.7

en-US/Get-PSGoodFirstIssue-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-PSGoodFirstIssue</command:name>

      <command:verb>Get</command:verb>

      <command:noun>PSGoodFirstIssue</command:noun>

      <maml:description>

        <maml:para>Gets a random issue from github.com/Powershell/Powershell labeled `Up-for-grabs`</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Gets a random issue from github.com/Powershell/Powershell labeled `Up-for-grabs`</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-PSGoodFirstIssue</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>OauthToken</maml:name>

          <maml:Description>

            <maml:para>After 60 calls to the API in an hour, github will block you. Use an oAuth token from https://github.com/settings/tokens (https://github.com/settings/tokens)to authenticate in that case</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>Repo</maml:name>

          <maml:Description>

            <maml:para>The repo to search in. Use `owner/repo` format.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>powershell/powershell</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>Labels</maml:name>

          <maml:Description>

            <maml:para>Label to get a random issue from. Per the github api spec it should be possible with a comma separated list, but it does not currently work.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>up-for-grabs</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

        <maml:name>Labels</maml:name>

        <maml:Description>

          <maml:para>Label to get a random issue from. Per the github api spec it should be possible with a comma separated list, but it does not currently work.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>up-for-grabs</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>OauthToken</maml:name>

        <maml:Description>

          <maml:para>After 60 calls to the API in an hour, github will block you. Use an oAuth token from https://github.com/settings/tokens (https://github.com/settings/tokens)to authenticate in that case</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>Repo</maml:name>

        <maml:Description>

          <maml:para>The repo to search in. Use `owner/repo` format.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>powershell/powershell</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-PSGoodFirstIssue</dev:code>

        <dev:remarks>

          <maml:para>Gets a random issue labeled `up-for-grabs` from the powershell/powershell repo.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; Get-PSGoodFirstIssue -Repo "Powershell/vscode-powershell"</dev:code>

        <dev:remarks>

          <maml:para>Gets a random issue labeled `up-for-grabs` from the powershell/vscode-powershell repo.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 3 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-PSGoodFirstIssue -Repo "Powershell/vscode-powershell" -Labels "Issue-bug"</dev:code>

        <dev:remarks>

          <maml:para>Gets a random issue labeled `Issue-bug` from the powershell/vscode-powershell repo.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

        <maml:title>-------------------------- Example 4 --------------------------</maml:title>

        <dev:code>PS C:\&gt; $iss = Get-PSGoodFirstIssue

PS C:\&gt; $iss | Select-Object -Property *</dev:code>

        <dev:remarks>

          <maml:para>Will list all available properties, not just the pretty synopsis.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-PSHacktoberFestIssue</command:name>

      <command:verb>Get</command:verb>

      <command:noun>PSHacktoberFestIssue</command:noun>

      <maml:description>

        <maml:para>Gets a random issue from with language `powershell` labeled `Hacktoberfest`.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Gets a random issue from with language `powershell` labeled `Hacktoberfest`.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-PSHacktoberFestIssue</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>OauthToken</maml:name>

          <maml:Description>

            <maml:para>The Search API has a custom rate limit. For requests using Basic Authentication, OAuth, or client ID and secret, you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>Language</maml:name>

          <maml:Description>

            <maml:para>Limit searches to a given language</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>powershell</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

          <maml:name>Label</maml:name>

          <maml:Description>

            <maml:para>Label to get a random issue from. Per the github api spec it should be possible with a comma separated list, but it does not currently work.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>hactoberfest</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

          <maml:name>State</maml:name>

          <maml:Description>

            <maml:para>Can be used to return issues that are closed. Defaults to open.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

          <dev:type>

            <maml:name>Object</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>Open</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">

        <maml:name>Label</maml:name>

        <maml:Description>

          <maml:para>Label to get a random issue from. Per the github api spec it should be possible with a comma separated list, but it does not currently work.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>hactoberfest</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>Language</maml:name>

        <maml:Description>

          <maml:para>Limit searches to a given language</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>powershell</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>OauthToken</maml:name>

        <maml:Description>

          <maml:para>The Search API has a custom rate limit. For requests using Basic Authentication, OAuth, or client ID and secret, you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">

        <maml:name>State</maml:name>

        <maml:Description>

          <maml:para>Can be used to return issues that are closed. Defaults to open.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

        <dev:type>

          <maml:name>Object</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>Open</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Object</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>PS C:\&gt; Get-PSHacktoberFestIssue</dev:code>

        <dev:remarks>

          <maml:para>Gets a random issue with the label `hacktoberfest` and language powershell.</maml:para>

        </dev:remarks>

      </command:example>

      <command:example>

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

        <dev:code>PS C:\&gt; Get-PSHacktoberFestIssue -OauthToken $token</dev:code>

        <dev:remarks>

          <maml:para>Uses a given token to authenticate user.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>