feat(GraphQL): add type documentation for query and operationName (…

…#662) Add type documentation for query and operationName
octokit · Jan 31, 2025 · bb399b2 · bb399b2
1 parent b6db78e
commit bb399b2
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/RequestParameters.ts b/src/RequestParameters.ts
@@ -31,6 +31,16 @@ export type RequestParameters = {
      */
     previews?: string[];
   };
+  /**
+   * The name of the operation to execute.
+   * Required only if multiple operations are present in the query document.
+   */
+  operationName?: string;
+  /**
+   * The GraphQL query string to be sent in the request.
+   * This is required and must contain a valid GraphQL document.
+   */
+  query?: string;
   /**
    * Pass custom meta information for the request. The `request` object will be returned as is.
    */