en-US/Utilities-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>Invoke-GithubApi</command:name> <maml:description> <maml:para>Invokes the GitHub REST API directly.</maml:para> </maml:description> <command:verb>Invoke</command:verb> <command:noun>GithubApi</command:noun> </command:details> <maml:description> <maml:para>Sends an authenticated request to the GitHub REST API. Handles authentication, pagination, and serialization. This is the low-level function used by all other cmdlets in the module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-GithubApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Method"> <maml:name>HttpMethod</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>Query</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Accept</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Accept</maml:name> <maml:description> <maml:para>The Accept header value for the API request. Defaults to 'application/vnd.github+json'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The comment body text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Method"> <maml:name>HttpMethod</maml:name> <maml:description> <maml:para>The HTTP method (GET, POST, PATCH, PUT, DELETE).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>Maximum number of pages of results to return. Each page contains up to 30 items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Filter commits by file path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>Query</maml:name> <maml:description> <maml:para>The search query string using GitHub search syntax.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>Sends an authenticated request to the GitHub REST API. Handles authentication, pagination, and serialization. This is the low-level function used by all other cmdlets in the module.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Invoke-GithubApi GET 'repos/owner/repo'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest</maml:linkText> <maml:uri>https://docs.github.com/en/rest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |