Merge pull request #686 from github/graphql-queries-update

sn2b · web-flow · commit 791608529c68 · 2023-10-25T11:52:49.000+02:00
Clean up variable names, remove broken objects, prettify queries, add pagination example
diff --git a/graphql/queries/1-org-members.graphql b/graphql/queries/1-org-members.graphql
@@ -1,14 +1,14 @@
 query {
-    organization(login:"github") {
-        login
-        name
-        members(first:100) {
-            edges {
-                node {
-                    login
-                    location
-                }
-            }
+  organization(login: "ORG_NAME") {
+    login
+    name
+    members(first: 100) {
+      edges {
+        node {
+          login
+          location
         }
+      }
     }
+  }
 }
diff --git a/graphql/queries/10-mutation-issue-comment-get-issue.graphql b/graphql/queries/10-mutation-issue-comment-get-issue.graphql
diff --git a/graphql/queries/10-query-issue-comment-get-issue.graphql b/graphql/queries/10-query-issue-comment-get-issue.graphql
@@ -0,0 +1,13 @@
+query getRepoIssue($orgName: String!, $repoName: String!) {
+  repository(owner: $orgName, name: $repoName) {
+    issues(last: 1) {
+      edges {
+        node {
+          number
+          id
+          body
+        }
+      }
+    }
+  }
+}
diff --git a/graphql/queries/11-mutation-issue-comment-add.graphql b/graphql/queries/11-mutation-issue-comment-add.graphql
@@ -1,11 +1,13 @@
+# Get ISSUE_ID from graphql/queries/10-query-issue-comment-get-issue.graphql
+
 mutation {
     addComment (
         input: {
             body: "Added by GraphQL",
-            subjectId:"<RETURNED_BY_PREVIOUS_CALL>"
+            subjectId:"ISSUE_ID"
         })
 
     {
         clientMutationId
     }
-}
+}
diff --git a/graphql/queries/2-org-members-variable.graphql b/graphql/queries/2-org-members-variable.graphql
@@ -1,18 +1,14 @@
-query ($orgLogin:String!) {
-    organization(login: $orgLogin) {
-        login
-        name
-        members(first:100) {
-            edges {
-                node {
-                    login
-                    location
-                }
-            }
+query {
+  organization(login: "ORG_NAME") {
+    login
+    name
+    membersWithRole(first: 100) {
+      edges {
+        node {
+          login
+          location
         }
+      }
     }
-}
-
-variables {
-    "orgLogin": "bidnessforb"
+  }
 }
diff --git a/graphql/queries/3-org-members-commit-msgs.graphql b/graphql/queries/3-org-members-commit-msgs.graphql
@@ -1,26 +1,26 @@
-{
-    organization(login: "github") {
-        login
-        name
-        members(first: 100) {
-            edges {
-                node {
-                    login
-                    location
-                }
-            }
+query {
+  organization(login: "ORG_NAME") {
+    login
+    name
+    members(first: 100) {
+      edges {
+        node {
+          login
+          location
+        }
+      }
+      edges {
+        node {
+          commitComments(first: 3) {
             edges {
-                node {
-                    commitComments(first: 3) {
-                        edges {
-                            node {
-                                id
-                                body
-                            }
-                        }
-                    }
-                }
+              node {
+                id
+                body
+              }
             }
+          }
         }
+      }
     }
+  }
 }
diff --git a/graphql/queries/4-org-repos-fragment.graphql b/graphql/queries/4-org-repos-fragment.graphql
@@ -1,5 +1,5 @@
 query {
-    organization(login: "github") {
+    organization(login: "ORG_NAME") {
         repositories {
             ...repoFrag
         }
diff --git a/graphql/queries/5-org-repos-fragment-2.graphql b/graphql/queries/5-org-repos-fragment-2.graphql
@@ -1,5 +1,5 @@
 query {
-    organization(login: "github") {
+    organization(login: "ORG_NAME") {
         ...orgFrag
         repositories {
             ...repoFrag
diff --git a/graphql/queries/7-org-with-variables.graphql b/graphql/queries/7-org-with-variables.graphql
@@ -1,8 +1,8 @@
-query getOrg($orgLogin:String!) {
-    organization(login: $orgLogin) {
+query getOrg($orgName:String!) {
+    organization(login: $orgName) {
         login
         name
-        members(first: 100) {
+        membersWithRole(first: 100) {
             edges {
                 node {
                     login
@@ -14,5 +14,5 @@ query getOrg($orgLogin:String!) {
 }
 
 variables {
-    "orgLogin": "github"
-}
+    "orgName": "ORG_NAME"
+}
diff --git a/graphql/queries/branches-and-commits-by-repository.graphql b/graphql/queries/branches-and-commits-by-repository.graphql
@@ -1,7 +1,7 @@
-query getCommitsByBranchByRepo($org:String!, $repo:String!) {
-  organization(login:$org) {
+query getCommitsByBranchByRepo($orgName:String!, $repoName:String!) {
+  organization(login:$orgName) {
     name
-    repository(name:$repo) {
+    repository(name:$repoName) {
       name
       refs(refPrefix: "refs/heads/", first: 10) {
         nodes {
@@ -33,4 +33,4 @@ query getCommitsByBranchByRepo($org:String!, $repo:String!) {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/emu-list-enterprise-member-email-addresses.graphql b/graphql/queries/emu-list-enterprise-member-email-addresses.graphql
@@ -1,8 +1,8 @@
 # This GraphQL query will print a list of all EMU (Enterprise Managed User) member email addresses, usernames, and display names in an enterprise.
 # This query will not work properly for enterprises that do not use EMUs, as non-EMU enterprises contain personal user accounts and therefore email addresses may be private depending on the user profile configuration. 
 
-{
-  enterprise(slug: "enterprise slug") {
+query {
+  enterprise(slug: "ENT_SLUG") {
     members(first: 100) {
       nodes {
         ... on EnterpriseUserAccount {
@@ -20,4 +20,4 @@
       }
     }
   }
-}
+}
diff --git a/graphql/queries/enterprise-audit-log.graphql b/graphql/queries/enterprise-audit-log.graphql
@@ -3,8 +3,8 @@
 # Make sure that you set the request to `POST` with URL `https://api.github.com/graphql`
 # Set `Headers` where `Content-Type` is `application/json` and `Accept` is `application/vnd.github.audit-log-preview+json`
 
-{
-  enterprise(slug: "<enterprise-slug>") {
+query {
+  enterprise(slug: "ENT_SLUG") {
     organizations(first: 100){
       nodes {
         auditLog(last: 5) {
@@ -31,7 +31,7 @@
 
 # If you'd like to use environment variables, this is what it would look like:
 
-query getAuditLog($slug: String!, $numEntries: Int!, $cursor: String){
+query getAuditLog($entSlug: String!, $numEntries: Int!, $cursor: String){
   enterprise(slug: $slug) {
     organizations(first: 100){
       nodes {
@@ -63,7 +63,7 @@ query getAuditLog($slug: String!, $numEntries: Int!, $cursor: String){
 
 # Envrionment variables:
 {
-	"slug": "<enterprise-slug>",
+	"entSlug": "<enterprise-slug>",
 	"numEntries": 5,
 	"cursor": null
-}
+}
diff --git a/graphql/queries/org-audit-log-api-example.graphql b/graphql/queries/org-audit-log-api-example.graphql
@@ -2,7 +2,7 @@
 # When querying an enterprise instance via GraphQL, the endpoint will follow the syntax: “https://<HOST>/api/graphql" - ex;"GRAPHQL_ENDPOINT": “https://34.208.232.154/api/graphql"
 
 query {
-  organization(login: "se-saml") {
+  organization(login: "ORG_NAME") {
     auditLog(first: 50) {
       edges {
         node {
@@ -48,4 +48,4 @@ query {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/org-members-by-team.graphql b/graphql/queries/org-members-by-team.graphql
@@ -22,4 +22,4 @@ query getMembersByTeam($orgName: String!, $teamName: String!) {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/repo-get-all-branches.graphql b/graphql/queries/repo-get-all-branches.graphql
@@ -15,4 +15,4 @@ query getExistingRepoBranches($orgName: String!, $repoName: String!) {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/repositories_with_stargazers.graphql b/graphql/queries/repositories_with_stargazers.graphql
@@ -19,4 +19,4 @@ query {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/repository_overview.graphql b/graphql/queries/repository_overview.graphql
@@ -1,19 +1,20 @@
-query { 
-  repositoryOwner(login: "git") { 
-    repository(name: "git") {
-      description hasWikiEnabled
+query {
+  repositoryOwner(login: "OWNER_LOGIN") {
+    repository(name: "REPO_NAME") {
+      description
+      hasWikiEnabled
       issues(states: OPEN) {
         totalCount
-      } 
+      }
       pullRequests(states: OPEN) {
-        totalCount 
-      } 
+        totalCount
+      }
       stargazers {
         totalCount
-      } 
+      }
       forks {
         totalCount
       }
     }
   }
-}
+}
diff --git a/graphql/queries/saml-identities-enterprise-level.graphql b/graphql/queries/saml-identities-enterprise-level.graphql
@@ -1,10 +1,10 @@
 # For GitHub Enterprise Cloud enterprises that have SAML configured at the enterprise level, this query will print a list of the first 100 SAML identities (specifically the `nameId` attribute value) in the enterprise and the linked GitHub username (if the SAML identity is linked).
 # An email address often gets used for the SAML `nameId` value, but this is not always the case. 
 # If the Identity Provider has sent an `emails` attribute/value in a previous SAML response for enterprise member(s), it also possible to add the `emails` attribute in the `samlIdentity` section right below `nameID` and query for this SAML identity attribute value as well. 
-# If there are a large number of identities/users (greater than 100), pagination will need to be used. See https://graphql.org/learn/pagination/ for details on pagination. 
+# If there are a large number of identities/users (greater than 100), pagination will need to be used. See https://graphql.org/learn/pagination/ for details on pagination. There is an example of pagination in simple-pagination-example.graphql.
  
-query listSSOUserIdentities ($enterpriseName:String!) {
-  enterprise(slug: $enterpriseName) {
+query listSSOUserIdentities($enterpriseSlug: String!) {
+  enterprise(slug: $enterpriseSlug) {
     ownerInfo {
       samlIdentityProvider {
         externalIdentities(first: 100) {
@@ -22,10 +22,10 @@ query listSSOUserIdentities ($enterpriseName:String!) {
           }
           pageInfo {
             hasNextPage
-	    endCursor
+            endCursor
           }
         }
       }
     }
   }
-}
+}
diff --git a/graphql/queries/saml-identities-single-organization.graphql b/graphql/queries/saml-identities-single-organization.graphql
@@ -1,11 +1,11 @@
 # For GitHub Enterprise Cloud organizations that have SAML configured at the organization level, this query will print out a list of the first 100 SAML identities (specifically the `nameid` attribute value in these SAML identities) in the organization and the GitHub username linked to them.
 # This query can be used to see which users in a GitHub Enterprise Cloud organization have a linked SAML identity.
 # This query will not print out a user username (`login`) value if there is not a GitHub user account linked to this SAML identity. 
-# If there are a large number of identities/users (greater than 100), pagination will need to be used. See https://graphql.org/learn/pagination/ for details on pagination. 
+# If there are a large number of identities/users (greater than 100), pagination will need to be used. See https://graphql.org/learn/pagination/ for details on pagination. There is an example of pagination in simple-pagination-example.graphql.
 
 
 query OrgSAMLidentities {
-  organization(login: "organization name") {
+  organization(login: "ORG_NAME") {
     samlIdentityProvider {
       externalIdentities(first: 100) {
         edges {
@@ -24,4 +24,4 @@ query OrgSAMLidentities {
       }
     }
   }
-}
+}
diff --git a/graphql/queries/scim-emu-enterprises-list-scim-identities.graphql b/graphql/queries/scim-emu-enterprises-list-scim-identities.graphql
@@ -3,8 +3,8 @@
 # The SCIM identity attributes that are stored in a GitHub EMU enterprise are based on the attributes that the external Identity Provider has previously sent for each user via the SCIM integration which leverages the GitHub EMU SCIM API.
 # The query will not work for EMU enterprises that are using SAML as the enterprise authentication method. 
  
-{
-  enterprise(slug: "enterprise slug") {
+query {
+  enterprise(slug: "ENT_SLUG") {
     ownerInfo {
       oidcProvider {
         id
@@ -34,5 +34,4 @@
       }
     }
   }
-}
-
+}
diff --git a/graphql/queries/scim-emu-list-enterprise-scim-identities.graphql b/graphql/queries/scim-emu-list-enterprise-scim-identities.graphql
diff --git a/graphql/queries/scim-identities-all-orgs-in-enterprise.graphql b/graphql/queries/scim-identities-all-orgs-in-enterprise.graphql
diff --git a/graphql/queries/scim-identities-single-organization.graphql b/graphql/queries/scim-identities-single-organization.graphql
diff --git a/graphql/queries/search-for-issue-or-bug-requests.graphql b/graphql/queries/search-for-issue-or-bug-requests.graphql
diff --git a/graphql/queries/simple-pagination-example.graphql b/graphql/queries/simple-pagination-example.graphql
diff --git a/graphql/queries/viewer.graphql b/graphql/queries/viewer.graphql

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`query {`
`2`		`- organization(login: "github") {`
	`2`	`+ organization(login: "ORG_NAME") {`
`3`	`3`	`repositories {`
`4`	`4`	`...repoFrag`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`		`-query getCommitsByBranchByRepo($org:String!, $repo:String!) {`
`2`		`- organization(login:$org) {`
	`1`	`+query getCommitsByBranchByRepo($orgName:String!, $repoName:String!) {`
	`2`	`+ organization(login:$orgName) {`
`3`	`3`	`name`
`4`		`- repository(name:$repo) {`
	`4`	`+ repository(name:$repoName) {`
`5`	`5`	`name`
`6`	`6`	`refs(refPrefix: "refs/heads/", first: 10) {`
`7`	`7`	`nodes {`
`@@ -33,4 +33,4 @@ query getCommitsByBranchByRepo($org:String!, $repo:String!) {`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`	`}`
`36`		`-}`
	`36`	`+}`