GitlabCli

1.170.0

en-US/MergeRequests/MergeRequests-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems 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" schema="maml" xmlns="http://msh">
  <command:command>
    <command:details>
      <command:name>Get-GitlabMergeRequestApproval</command:name>
      <maml:description>
        <maml:para>Gets approval information for a merge request.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>GitlabMergeRequestApproval</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Returns the approval status of a merge request, including the number of required and remaining approvals, and the list of users who have approved.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-GitlabMergeRequestApproval</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
          <maml:name>MergeRequestId</maml:name>
          <maml:description>
            <maml:para>The IID of the merge request.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>ProjectId</maml:name>
          <maml:description>
            <maml:para>The project ID or path. Defaults to the current directory.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>SiteUrl</maml:name>
          <maml:description>
            <maml:para>The GitLab site URL to use. Defaults to the configured default site.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
        <maml:name>MergeRequestId</maml:name>
        <maml:description>
          <maml:para>The IID of the merge request.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>ProjectId</maml:name>
        <maml:description>
          <maml:para>The project ID or path. Defaults to the current directory.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>SiteUrl</maml:name>
        <maml:description>
          <maml:para>The GitLab site URL to use. Defaults to the configured default site.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>ProjectId and MergeRequestId can be provided via pipeline by property name.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.Management.Automation.PSObject</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns an object with ApprovalsRequired, ApprovalsLeft, and ApprovedBy properties.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Uses the GitLab merge request approvals API endpoint.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
Get-GitlabMergeRequestApproval -ProjectId 123 -MergeRequestId 456
```</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Approve-GitlabMergeRequest</maml:linkText>
        <command:uri>Approve-GitlabMergeRequest.md</command:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
  <command:command>
    <command:details>
      <command:name>Get-GitlabMergeRequestApproval</command:name>
      <maml:description>
        <maml:para>Gets approval information for a merge request.</maml:para>
      </maml:description>
      <command:verb>Get</command:verb>
      <command:noun>GitlabMergeRequestApproval</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Returns the approval status of a merge request, including the number of required and remaining approvals, and the list of users who have approved.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-GitlabMergeRequestApproval</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
          <maml:name>MergeRequestId</maml:name>
          <maml:description>
            <maml:para>The IID of the merge request.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
          <maml:name>ProjectId</maml:name>
          <maml:description>
            <maml:para>The project ID or path. Defaults to the current directory.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>SiteUrl</maml:name>
          <maml:description>
            <maml:para>The GitLab site URL to use. Defaults to the configured default site.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
        <maml:name>MergeRequestId</maml:name>
        <maml:description>
          <maml:para>The IID of the merge request.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">
        <maml:name>ProjectId</maml:name>
        <maml:description>
          <maml:para>The project ID or path. Defaults to the current directory.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>SiteUrl</maml:name>
        <maml:description>
          <maml:para>The GitLab site URL to use. Defaults to the configured default site.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>ProjectId and MergeRequestId can be provided via pipeline by property name.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>System.Management.Automation.PSObject</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>Returns an object with ApprovalsRequired, ApprovalsLeft, and ApprovedBy properties.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>Uses the GitLab merge request approvals API endpoint.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
Get-GitlabMergeRequestApproval -ProjectId 123 -MergeRequestId 456
```</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version</maml:linkText>
        <command:uri />
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Approve-GitlabMergeRequest</maml:linkText>
        <command:uri>Approve-GitlabMergeRequest.md</command:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>