Skip to content

Invoke-GitHubGraphQLQuery

SYNOPSIS

Invoke a GraphQL requests against the GitHub GraphQL API

SYNTAX

Invoke-GitHubGraphQLQuery [-Query] <String> [[-Variables] <Hashtable>] [[-Context] <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Use this function to invoke a GraphQL query and mutations against the GitHub GraphQL API with proper error handling.

EXAMPLES

EXAMPLE 1

Invoke-GitHubGraphQLQuery -Query $query -Variables $Variables

PARAMETERS

-Query

If specified, makes an anonymous request to the GitHub API without authentication.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Variables

Variables to pass to the GraphQL query.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

GitHub GraphQL API documentation

https://psmodule.io/GitHub/Functions/API/Invoke-GitHubGraphQLQuery