diff --git a/docs/api/graphql/index.mdx b/docs/api/graphql/index.mdx index d0fa78538..1dfc43320 100644 --- a/docs/api/graphql/index.mdx +++ b/docs/api/graphql/index.mdx @@ -48,17 +48,21 @@ For automated scripts, CI/CD pipelines, and production integrations, use [servic ## Documentation & tooling -### API Console +### API Console and documentation -Sourcegraph includes a built-in API console that lets you write queries and view API documentation in your browser. +Sourcegraph includes a built-in API console that lets you write queries and +view API documentation in your browser. -You can find the API console at any time by going to **Settings**, and then clicking **API console** from the left sidebar, or by visiting it directly at `https://sourcegraph.example.com/api/console`. +You can find the API console at any time by going to **Settings**, and then +clicking **API console** from the left sidebar, or by visiting it directly at +`https://sourcegraph.example.com/api/console`. -If you have not yet set up a Sourcegraph server, you can also test out the API on the [Sourcegraph.com API console](https://sourcegraph.com/api/console) (which always uses the latest version of the API). +If you have not yet set up a Sourcegraph server, you can also test out the API +on the [Sourcegraph.com API console](https://sourcegraph.com/api/console) (which +always uses the latest version of the API). -### Documentation - -Sourcegraph's GraphQL API documentation is available on the [API Docs](/api/graphql/api-docs) page, as well as directly in the API console itself. To access the documentation, click **Docs** on the right-hand side of the API console page. +To access the documentation, click **Docs** on the right-hand side of the API +console page. ### Search diff --git a/src/app/api/graphql/api-docs/page.tsx b/src/app/api/graphql/api-docs/page.tsx deleted file mode 100644 index 0a876c995..000000000 --- a/src/app/api/graphql/api-docs/page.tsx +++ /dev/null @@ -1,78116 +0,0 @@ -import { Breadcrumbs } from '@/components/Breadcrumbs'; -import { PrevNextLinks } from '@/components/PrevNextLinks'; -import { Prose } from '@/components/Prose'; - -const PostLayout = () => { - - return ( - <> -
- -
- - <> -
-
- -
-
- -
-
-

Sourcegraph API

-

- Queries -

-
-

- areExecutorsConfigured -

-
-
-
-
Description
-

- Returns true if executors have been configured on the - Sourcegraph instance. This is based on heuristics and - doesn't necessarily mean that they would be working. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Boolean! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    areExecutorsConfigured{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        areExecutorsConfigured
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  
-                                    "areExecutorsConfigured"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- autocompleteMembersSearch -

-
-
-
-
Description
-

Search for users that opt-in to search autocomplete.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [AutocompleteMemberSearchItem!]! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - - The organization ID
- - query - {" "} - -{" "} - - - String! - - - - {" "} - Return users whose usernames or display names match - the query.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    autocompleteMembersSearch
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $organization: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $query:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        autocompleteMembersSearch
-                                        
-                                          ({"\n"}
-                                          {"    "}organization:{" "}
-                                          $organization,
-                                          {"\n"}
-                                          {"    "}query:{" "}
-                                          $query
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          username
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          avatarURL
-                                          {"\n"}
-                                          {"    "}
-                                          inOrg
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "organization"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "query"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "autocompleteMembersSearch"
-                                  
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"      "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"        "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "username"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "inOrg"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"      "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  ]
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- backgroundJobs -

-
-
-
-
Description
-

- Get a list of background jobs that are currently known in - the system. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - BackgroundJobConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n jobs. If omitted then it returns - all of them.{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
- - recentRunCount - {" "} - -{" "} - - - Int - - - - {" "} - The maximum number of recent runs to return for each - routine.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    backgroundJobs
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $recentRunCount:
-                                       Int{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        backgroundJobs
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}recentRunCount:{" "}
-                                          $recentRunCount
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...BackgroundJobFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "recentRunCount"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "backgroundJobs"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  BackgroundJob
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- clientConfiguration -

-
-
-
-
Description
-

The configuration for clients.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - ClientConfigurationDetails! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    clientConfiguration{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        clientConfiguration{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            contentScriptUrls
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentSourcegraph{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ParentSourcegraphDetailsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "clientConfiguration"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "contentScriptUrls"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentSourcegraph"
-                                  :{" "}
-                                  
-                                    ParentSourcegraphDetails
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- codeHostSyncDue -

-
-
-
-
Description
-

- Returns true if any of the code hosts supplied are syncing - now or within "seconds" from now. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Boolean! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - ids - {" "} - -{" "} - - - [ID!]! - - -
- - seconds - {" "} - -{" "} - - - Int! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    codeHostSyncDue
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $ids: [ID!]!,{"\n"}
-                                      {"  "}
-                                      $seconds:
-                                       Int!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        codeHostSyncDue
-                                        
-                                          ({"\n"}
-                                          {"    "}ids:{" "}
-                                          $ids,{"\n"}
-                                          {"    "}seconds:{" "}
-                                          $seconds
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "ids"
-                                  :{" "}
-                                  [
-                                  "4"
-                                  ]
-                                  ,{" "}
-                                  "seconds"
-                                  :{" "}
-                                  123
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "codeHostSyncDue"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- currentUser -

-
-
-
-
Description
-

The current user.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - User - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query currentUser{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        currentUser{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          username
-                                          {"\n"}
-                                          {"    "}
-                                          email
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          avatarURL
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          siteAdmin
-                                          {"\n"}
-                                          {"    "}
-                                          builtinAuth
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizations{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizationMemberships{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationMembershipConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          tags
-                                          {"\n"}
-                                          {"    "}
-                                          tosAccepted
-                                          {"\n"}
-                                          {"    "}
-                                          searchable
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            usageStatistics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserUsageStatisticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            eventLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...EventLogsConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            emails{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserEmailFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessTokens{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AccessTokenConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalAccounts{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalAccountConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            session{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SessionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanChangeUsername
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            surveyResponses{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SurveyResponseFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          databaseID
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            invitableCollaborators{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PersonFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            teams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "currentUser"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "siteAdmin"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "builtinAuth"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organizations"
-                                  :{" "}
-                                  OrgConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "organizationMemberships"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationMembershipConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tags"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tosAccepted"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "searchable"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "usageStatistics"
-                                  :{" "}
-                                  UserUsageStatistics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "eventLogs"
-                                  :{" "}
-                                  EventLogsConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "emails"
-                                  :{" "}
-                                  [
-                                  UserEmail
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessTokens"
-                                  :{" "}
-                                  AccessTokenConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalAccounts"
-                                  :{" "}
-                                  
-                                    ExternalAccountConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "session"
-                                  :{" "}
-                                  Session
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerCanChangeUsername"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "surveyResponses"
-                                  :{" "}
-                                  [
-                                  SurveyResponse
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "databaseID"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "invitableCollaborators"
-                                  
-                                  :{" "}
-                                  [
-                                  Person
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "teams"
-                                  :{" "}
-                                  TeamConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- evaluateFeatureFlag -

-
-
-
-
Description
-

- Evaluates a feature flag for the current user Returns null - if feature flag does not exist -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Boolean - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - flagName - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    evaluateFeatureFlag
-                                    
-                                      ($flagName:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        evaluateFeatureFlag
-                                        
-                                          (flagName:{" "}
-                                          $flagName)
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "flagName"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "evaluateFeatureFlag"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- evaluatedFeatureFlags -

-
-
-
-
Description
-

- Retrieve all evaluated feature flags for the current user -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [EvaluatedFeatureFlag!]! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    evaluatedFeatureFlags{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        evaluatedFeatureFlags{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          value
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "evaluatedFeatureFlags"
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"      "}
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,{" "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  ]
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- executorSecrets -

-
-
-
-
Description
-

The list of all globally available executor secrets.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExecutorSecretConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - - - {" "} - The scope for which secrets shall be returned.{" "} -
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Only return N records. Default = 50{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque cursor for pagination.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    executorSecrets
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $scope:
-                                      
-                                        {" "}
-                                        ExecutorSecretScope!
-                                      
-                                      ,{"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        executorSecrets
-                                        
-                                          ({"\n"}
-                                          {"    "}scope:{" "}
-                                          $scope,{"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  50
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  ExecutorSecret
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- executors -

-
-
-
-
Description
-

Retrieve active executor compute instances.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExecutorConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - query - {" "} - -{" "} - - - String - - - - {" "} - An (optional) search query that searches over the - hostname, queue name, os, architecture, and version - properties.{" "} -
- - active - {" "} - -{" "} - - - Boolean - - - - {" "} - Whether to show only executors that have sent a - heartbeat in the last fifteen minutes.{" "} -
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n executors. Default ={" "} - 50{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query executors
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $query:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $active:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        executors
-                                        
-                                          ({"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}active:{" "}
-                                          $active,{"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "active"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  50
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "executors"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Executor
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- extensionRegistry -

-
-
-
-
Description
-

The extension registry.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExtensionRegistry! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    extensionRegistry{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        extensionRegistry{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            extensions{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RegistryExtensionConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "extensionRegistry"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "extensions"
-                                  :{" "}
-                                  
-                                    RegistryExtensionConnection
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- externalServiceNamespaces -

-
-
-
-
Description
-

- Lists all namespaces for a given external service - connection. A namespace is an entity on the code host that - repositories are assignable to. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExternalServiceNamespaceConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - kind - {" "} - -{" "} - - - ExternalServiceKind! - - - The kind of the external service.
- - token - {" "} - -{" "} - - - String! - - - - {" "} - The secret token value that is used to authenticate.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The url of the external service.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    externalServiceNamespaces
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $kind:
-                                      
-                                        {" "}
-                                        ExternalServiceKind!
-                                      
-                                      ,{"\n"}
-                                      {"  "}
-                                      $token:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $url:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        externalServiceNamespaces
-                                        
-                                          ({"\n"}
-                                          {"    "}kind:{" "}
-                                          $kind,{"\n"}
-                                          {"    "}token:{" "}
-                                          $token,{"\n"}
-                                          {"    "}url:{" "}
-                                          $url
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceNamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "token"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "externalServiceNamespaces"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  
-                                    ExternalServiceNamespace
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- externalServices -

-
-
-
-
Description
-

- Lists external services under given namespace. If no - namespace is given, it returns all external services. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExternalServiceConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n external services from the list.{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    externalServices
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        externalServices
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,{" "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "externalServices"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  ExternalService
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- featureFlag -

-
-
-
-
Description
-

Retrieve a feature flag

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - FeatureFlag! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query featureFlag
-                                    
-                                      ($name:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        featureFlag
-                                        
-                                          (name: $name)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on FeatureFlagBoolean{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagBooleanFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on FeatureFlagRollout{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagRolloutFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "featureFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- featureFlags -

-
-
-
-
Description
-

Retrieve the list of defined feature flags

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [FeatureFlag!]! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query featureFlags{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        featureFlags{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on FeatureFlagBoolean{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagBooleanFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on FeatureFlagRollout{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagRolloutFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "featureFlags"
-                                  :{" "}
-                                  [
-                                  FeatureFlagBoolean
-                                  ]
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- highlightCode -

-
-
-
-
Description
-

EXPERIMENTAL: Syntax highlights a code string.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - String! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - code - {" "} - -{" "} - - - String! - - -
- - fuzzyLanguage - {" "} - -{" "} - - - String! - - -
- - disableTimeout - {" "} - -{" "} - - - Boolean! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    highlightCode
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $code:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $fuzzyLanguage:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $disableTimeout:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        highlightCode
-                                        
-                                          ({"\n"}
-                                          {"    "}code:{" "}
-                                          $code,{"\n"}
-                                          {"    "}fuzzyLanguage:{" "}
-                                          $fuzzyLanguage,
-                                          {"\n"}
-                                          {"    "}disableTimeout:{" "}
-                                          $disableTimeout
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "code"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "fuzzyLanguage"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "disableTimeout"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "highlightCode"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- invitationByToken -

-
-
-
-
Description
-

- (experimental) Get invitation based on the JWT in the - invitation URL -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - OrganizationInvitation! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - token - {" "} - -{" "} - - - String! - - - - {" "} - The token that uniquely identifies the invitation{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    invitationByToken
-                                    
-                                      ($token:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        invitationByToken
-                                        
-                                          (token: $token)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organization{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            sender{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            recipient{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            recipientEmail
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          notifiedAt
-                                          {"\n"}
-                                          {"    "}
-                                          respondedAt
-                                          {"\n"}
-                                          {"    "}
-                                          responseType
-                                          {"\n"}
-                                          {"    "}
-                                          respondURL
-                                          {"\n"}
-                                          {"    "}
-                                          revokedAt
-                                          {"\n"}
-                                          {"    "}
-                                          expiresAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            isVerifiedEmail
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "token"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "invitationByToken"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organization"
-                                  :{" "}
-                                  Org
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "sender"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "recipient"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "recipientEmail"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notifiedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "respondedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "responseType"
-                                  :{" "}
-                                  "ACCEPT"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "respondURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "revokedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "expiresAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "isVerifiedEmail"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- namespace -

-
-
-
-
Description
-

Look up a namespace by ID.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Namespace - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query namespace
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        namespace
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "namespace"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- namespaceByName -

-
-
-
-
Description
-

- Look up a namespace by name, which is a username or - organization name. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Namespace - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the namespace.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    namespaceByName
-                                    
-                                      ($name:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        namespaceByName
-                                        
-                                          (name: $name)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "namespaceByName"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- node -

-
-
-
-
Description
-

Looks up a node by ID.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Node - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query node
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        node
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "node"
-                                  :{" "}
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- orgMembersSummary -

-
-
-
-
Description
-

Get started organization summary

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - OrgMembersSummary! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - - The organization ID
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    orgMembersSummary
-                                    
-                                      ($organization:
-                                      ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        orgMembersSummary
-                                        
-                                          (organization:{" "}
-                                          $organization)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          membersCount
-                                          {"\n"}
-                                          {"    "}
-                                          invitesCount
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "orgMembersSummary"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "membersCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "invitesCount"
-                                  :{" "}
-                                  987
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- organization -

-
-
-
-
Description
-

Looks up an organization by name.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - Org - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query organization
-                                    
-                                      ($name:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        organization
-                                        
-                                          (name: $name)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NewUsersConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerPendingInvitation{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationInvitationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerIsMember
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "organization"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  NewUsersConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerPendingInvitation"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationInvitation
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerIsMember"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- organizationFeatureFlagOverrides -

-
-
-
-
Description
-

- Retrieve all organization feature flag overrides for the - current user -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [FeatureFlagOverride!]! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    organizationFeatureFlagOverrides{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        organizationFeatureFlagOverrides{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            targetFlag{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on FeatureFlagBoolean{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagBooleanFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on FeatureFlagRollout{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagRolloutFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              value
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "organizationFeatureFlagOverrides"
-                                  
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"      "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"        "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "targetFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"      "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  ]
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- organizationFeatureFlagValue -

-
-
-
-
Description
-

- Retrieve the value of a feature flag for the organization -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Boolean! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - orgID - {" "} - -{" "} - - - ID! - - -
- - flagName - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    organizationFeatureFlagValue
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $orgID: ID!,{"\n"}
-                                      {"  "}
-                                      $flagName:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        organizationFeatureFlagValue
-                                        
-                                          ({"\n"}
-                                          {"    "}orgID:{" "}
-                                          $orgID,{"\n"}
-                                          {"    "}flagName:{" "}
-                                          $flagName
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "orgID"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "flagName"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  
-                                    "organizationFeatureFlagValue"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- organizations -

-
-
-
-
Description
-

List all organizations.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - OrgConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n organizations from the list.{" "} -
- - query - {" "} - -{" "} - - - String - - - - {" "} - Return organizations whose names or display names - match the query.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    organizations
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $query:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        organizations
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}query:{" "}
-                                          $query
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,{" "}
-                                  "query"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "organizations"
-                                  :{" "}
-                                  {"{"}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Org
-                                  ]
-                                  ,{" "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- outOfBandMigrations -

-
-
-
-
Description
-

Retrieve all registered out-of-band migrations.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [OutOfBandMigration!]! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    outOfBandMigrations{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        outOfBandMigrations{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          team
-                                          {"\n"}
-                                          {"    "}
-                                          component
-                                          {"\n"}
-                                          {"    "}
-                                          description
-                                          {"\n"}
-                                          {"    "}
-                                          introduced
-                                          {"\n"}
-                                          {"    "}
-                                          deprecated
-                                          {"\n"}
-                                          {"    "}
-                                          progress
-                                          {"\n"}
-                                          {"    "}
-                                          created
-                                          {"\n"}
-                                          {"    "}
-                                          lastUpdated
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nonDestructive
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          applyReverse
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            errors{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OutOfBandMigrationErrorFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "outOfBandMigrations"
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"      "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"        "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "team"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "component"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "description"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "introduced"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "deprecated"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "progress"
-                                  :{" "}
-                                  123.45
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "created"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "lastUpdated"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "nonDestructive"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "applyReverse"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "errors"
-                                  :{" "}
-                                  [
-                                  
-                                    OutOfBandMigrationError
-                                  
-                                  ]
-                                  {"\n"}
-                                  {"      "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  ]
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- outboundRequests -

-
-
-
-
Description
-

- Get a log of the latest outbound external requests. Only - available to site admins. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - OutboundRequestConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n log items. If omitted then it - returns all of them.{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    outboundRequests
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        outboundRequests
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OutboundRequestFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,{" "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "outboundRequests"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  OutboundRequest
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- packageRepoReferences -

-
-
-
-
Description
-

Query package repo references.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - PackageRepoReferenceConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - scheme - {" "} - -{" "} - - - PackageRepoReferenceKind - - - The exact scheme value to filter by.
- - name - {" "} - -{" "} - - - String - - - - {" "} - If supplied, only package repo references that match - the given terms by their name will be returned. TODO: - fuzzy vs exact?{" "} -
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n external services from the list.{" "} -
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    packageRepoReferences
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $scheme:
-                                      
-                                        {" "}
-                                        PackageRepoReferenceKind,
-                                      
-                                      {"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        packageRepoReferences
-                                        
-                                          ({"\n"}
-                                          {"    "}scheme:{" "}
-                                          $scheme,{"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PackageRepoReferenceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "scheme"
-                                  :{" "}
-                                  "GOMODULES"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "packageRepoReferences"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  PackageRepoReference
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- parseSearchQuery -

-
-
-
-
Description
-

(experimental) Return the parse tree of a search query.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - String! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - query - {" "} - -{" "} - - - String - - - - {" "} - The search query (such as "repo:myrepo foo"). Default - = ""{" "} -
- - patternType - {" "} - -{" "} - - - SearchPatternType - - - - {" "} - The parser to use for this query. Default ={" "} - standard{" "} -
- - outputPhase - {" "} - -{" "} - - - SearchQueryOutputPhase - - - - {" "} - The output corresponding to a phase in the parser - pipeline. Default = PARSE_TREE{" "} -
- - outputFormat - {" "} - -{" "} - - - SearchQueryOutputFormat - - - - {" "} - The parser output format. Default = - JSON - {" "} -
- - outputVerbosity - {" "} - -{" "} - - - SearchQueryOutputVerbosity - - - - {" "} - The level of output format verbosity. Default ={" "} - BASIC{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    parseSearchQuery
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $query:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $patternType:
-                                       SearchPatternType,
-                                      {"\n"}
-                                      {"  "}
-                                      $outputPhase:
-                                      
-                                        {" "}
-                                        SearchQueryOutputPhase,
-                                      
-                                      {"\n"}
-                                      {"  "}
-                                      $outputFormat:
-                                      
-                                        {" "}
-                                        SearchQueryOutputFormat,
-                                      
-                                      {"\n"}
-                                      {"  "}
-                                      $outputVerbosity:
-                                      
-                                        {" "}
-                                        SearchQueryOutputVerbosity{"\n"}
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        parseSearchQuery
-                                        
-                                          ({"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}patternType:{" "}
-                                          $patternType,
-                                          {"\n"}
-                                          {"    "}outputPhase:{" "}
-                                          $outputPhase,
-                                          {"\n"}
-                                          {"    "}outputFormat:{" "}
-                                          $outputFormat,
-                                          {"\n"}
-                                          {"    "}outputVerbosity:{" "}
-                                          
-                                            $outputVerbosity
-                                          
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  ""
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "patternType"
-                                  :{" "}
-                                  "standard"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "outputPhase"
-                                  :{" "}
-                                  "PARSE_TREE"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "outputFormat"
-                                  :{" "}
-                                  "JSON"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "outputVerbosity"
-                                  :{" "}
-                                  "BASIC"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "parseSearchQuery"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- pendingInvitations -

-
-
-
-
Description
-

Get pending invitations for the specific organization

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [OrganizationInvitation!]! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - - The organization ID
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    pendingInvitations
-                                    
-                                      ($organization:
-                                      ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        pendingInvitations
-                                        
-                                          (organization:{" "}
-                                          $organization)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organization{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            sender{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            recipient{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            recipientEmail
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          notifiedAt
-                                          {"\n"}
-                                          {"    "}
-                                          respondedAt
-                                          {"\n"}
-                                          {"    "}
-                                          responseType
-                                          {"\n"}
-                                          {"    "}
-                                          respondURL
-                                          {"\n"}
-                                          {"    "}
-                                          revokedAt
-                                          {"\n"}
-                                          {"    "}
-                                          expiresAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            isVerifiedEmail
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "pendingInvitations"
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"      "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"        "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "organization"
-                                  :{" "}
-                                  Org
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "sender"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "recipient"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "recipientEmail"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "notifiedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "respondedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "responseType"
-                                  :{" "}
-                                  "ACCEPT"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "respondURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "revokedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "expiresAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"        "}
-                                  "isVerifiedEmail"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"      "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  ]
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- phabricatorRepo -

-
-
-
-
Description
-

Looks up a Phabricator repository by name.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - PhabricatorRepo - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String - - - - {" "} - The name, for example "github.com/gorilla/mux".{" "} -
- - uri - {" "} - -{" "} - - - String - - - - {" "} - An alias for name. DEPRECATED: use name instead.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    phabricatorRepo
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $uri:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        phabricatorRepo
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}uri:{" "}
-                                          $uri
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          uri
-                                          {"\n"}
-                                          {"    "}
-                                          callsign
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "uri"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "phabricatorRepo"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "uri"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "callsign"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- renderMarkdown -

-
-
-
-
Description
-

- Renders Markdown to HTML. The returned HTML is already - sanitized and escaped and thus is always safe to render. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - String! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - markdown - {" "} - -{" "} - - - String! - - -
- - options - {" "} - -{" "} - - - MarkdownOptions - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    renderMarkdown
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $markdown:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $options:
-                                      
-                                        {" "}
-                                        MarkdownOptions{"\n"}
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        renderMarkdown
-                                        
-                                          ({"\n"}
-                                          {"    "}markdown:{" "}
-                                          $markdown,
-                                          {"\n"}
-                                          {"    "}options:{" "}
-                                          $options
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "markdown"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "options"
-                                  :{" "}
-                                  MarkdownOptions
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "renderMarkdown"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- repositories -

-
-
-
-
Description
-

List all repositories.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - NewRepositoryConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n repositories from the list.{" "} -
- - last - {" "} - -{" "} - - - Int - - - - {" "} - Returns the last n repositories from the list.{" "} -
- - query - {" "} - -{" "} - - - String - - - - {" "} - Return repositories whose names match the query.{" "} -
- - after - {" "} - -{" "} - - - String - - - An opaque cursor that is used for pagination.
- - before - {" "} - -{" "} - - - String - - - An opaque cursor that is used for pagination.
- - names - {" "} - -{" "} - - - [String!] - - - - {" "} - Return repositories whose names are in the list.{" "} -
- - cloned - {" "} - -{" "} - - - Boolean - - - - {" "} - Include cloned repositories. Default ={" "} - true{" "} -
- - cloneStatus - {" "} - -{" "} - - - CloneStatus - - - - {" "} - Include only repositories of the given clone status.{" "} -
- - notCloned - {" "} - -{" "} - - - Boolean - - - - {" "} - Include repositories that are not yet cloned and for - which cloning is not in progress. Default ={" "} - true{" "} -
- - indexed - {" "} - -{" "} - - - Boolean - - - - {" "} - Include repositories that have a text search index. - Default = true{" "} -
- - notIndexed - {" "} - -{" "} - - - Boolean - - - - {" "} - Include repositories that do not have a text search - index. Default = true{" "} -
- - failedFetch - {" "} - -{" "} - - - Boolean - - - - {" "} - Include only repositories that have encountered errors - when cloning or fetching. Default = - false - {" "} -
- - corrupted - {" "} - -{" "} - - - Boolean - - - - {" "} - Include repositories that are corrupt. Default ={" "} - false{" "} -
- - externalService - {" "} - -{" "} - - - ID - - - - {" "} - Return repositories that are associated with the given - external service.{" "} -
- - orderBy - {" "} - -{" "} - - - RepositoryOrderBy - - - - {" "} - Sort field. Default = - REPOSITORY_NAME - {" "} -
- - descending - {" "} - -{" "} - - - Boolean - - - - {" "} - Sort direction. Default = false{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query repositories
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $last:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $query:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $before:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $names:{" "}
-                                      [String!],{"\n"}
-                                      {"  "}
-                                      $cloned:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $cloneStatus:
-                                       CloneStatus,
-                                      {"\n"}
-                                      {"  "}
-                                      $notCloned:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $indexed:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $notIndexed:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $failedFetch:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $corrupted:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $externalService:
-                                      ID,{"\n"}
-                                      {"  "}
-                                      $orderBy:
-                                       RepositoryOrderBy,
-                                      {"\n"}
-                                      {"  "}
-                                      $descending:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        repositories
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}last:{" "}
-                                          $last,{"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}before:{" "}
-                                          $before,{"\n"}
-                                          {"    "}names:{" "}
-                                          $names,{"\n"}
-                                          {"    "}cloned:{" "}
-                                          $cloned,{"\n"}
-                                          {"    "}cloneStatus:{" "}
-                                          $cloneStatus,
-                                          {"\n"}
-                                          {"    "}notCloned:{" "}
-                                          $notCloned,
-                                          {"\n"}
-                                          {"    "}indexed:{" "}
-                                          $indexed,{"\n"}
-                                          {"    "}notIndexed:{" "}
-                                          $notIndexed,
-                                          {"\n"}
-                                          {"    "}failedFetch:{" "}
-                                          $failedFetch,
-                                          {"\n"}
-                                          {"    "}corrupted:{" "}
-                                          $corrupted,
-                                          {"\n"}
-                                          {"    "}externalService:{" "}
-                                          
-                                            $externalService
-                                          
-                                          ,{"\n"}
-                                          {"    "}orderBy:{" "}
-                                          $orderBy,{"\n"}
-                                          {"    "}descending:{" "}
-                                          $descending
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConnectionPageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "last"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "before"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "names"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cloned"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cloneStatus"
-                                  :{" "}
-                                  "NOT_CLONED"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notCloned"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "indexed"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notIndexed"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "failedFetch"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "corrupted"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalService"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "orderBy"
-                                  :{" "}
-                                  "REPOSITORY_NAME"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "descending"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "repositories"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Repository
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  ConnectionPageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- repository -

-
-
-
-
Description
-

Looks up a repository by either name or cloneURL.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Repository - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String - - - - {" "} - Query the repository by name, for example - "github.com/gorilla/mux".{" "} -
- - cloneURL - {" "} - -{" "} - - - String - - - - {" "} - Query the repository by a Git clone URL (format - documented here:{" "} - - https://git-scm.com/docs/git-clone_git_urls_a_id_urls_a - - ) by checking for a code host configuration that - matches the clone URL. Will not actually check the - code host to see if the repository actually exists.{" "} -
- - uri - {" "} - -{" "} - - - String - - - - {" "} - An alias for name. DEPRECATED: use name instead.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query repository
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $cloneURL:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $uri:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        repository
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}cloneURL:{" "}
-                                          $cloneURL,
-                                          {"\n"}
-                                          {"    "}uri:{" "}
-                                          $uri
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          uri
-                                          {"\n"}
-                                          {"    "}
-                                          description
-                                          {"\n"}
-                                          {"    "}
-                                          language
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            commit{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitCommitFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            firstEverCommit{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitCommitFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            mirrorInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...MirrorRepositoryInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalRepository{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalRepositoryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          isFork
-                                          {"\n"}
-                                          {"    "}
-                                          isArchived
-                                          {"\n"}
-                                          {"    "}
-                                          isPrivate
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalServices{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            cloneInProgress
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            textSearchIndex{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryTextSearchIndexFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalURLs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalLinkFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            defaultBranch{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitRefFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            gitRefs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitRefConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            branches{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitRefConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            tags{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitRefConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            comparison{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryComparisonFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            contributors{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryContributorConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            label{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...MarkdownFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            detail{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...MarkdownFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            matches{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SearchResultMatchFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            codeIntelligenceCommitGraph{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...CodeIntelligenceCommitGraphFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          stars
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            keyValuePairs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...KeyValuePairFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          diskSizeBytes
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cloneURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "uri"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "repository"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "uri"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "description"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "language"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "commit"
-                                  :{" "}
-                                  GitCommit
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "firstEverCommit"
-                                  :{" "}
-                                  GitCommit
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "mirrorInfo"
-                                  :{" "}
-                                  MirrorRepositoryInfo
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalRepository"
-                                  :{" "}
-                                  ExternalRepository
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "isFork"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "isArchived"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "isPrivate"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalServices"
-                                  :{" "}
-                                  
-                                    ExternalServiceConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "cloneInProgress"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "textSearchIndex"
-                                  :{" "}
-                                  
-                                    RepositoryTextSearchIndex
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalURLs"
-                                  :{" "}
-                                  [
-                                  ExternalLink
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "defaultBranch"
-                                  :{" "}
-                                  GitRef
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "gitRefs"
-                                  :{" "}
-                                  GitRefConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "branches"
-                                  :{" "}
-                                  GitRefConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tags"
-                                  :{" "}
-                                  GitRefConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "comparison"
-                                  :{" "}
-                                  RepositoryComparison
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "contributors"
-                                  :{" "}
-                                  
-                                    RepositoryContributorConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "label"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "detail"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "matches"
-                                  :{" "}
-                                  [
-                                  SearchResultMatch
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "codeIntelligenceCommitGraph"
-                                  
-                                  :{" "}
-                                  
-                                    CodeIntelligenceCommitGraph
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "stars"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "keyValuePairs"
-                                  :{" "}
-                                  [
-                                  KeyValuePair
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "diskSizeBytes"
-                                  :{" "}
-                                  {"{"}
-                                  {"}"}
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- repositoryRedirect -

-
-
-
-
Description
-

- Looks up a repository by either name or cloneURL or - hashedName. When the repository does not exist on the server - and "disablePublicRepoRedirects" is "false" in the site - configuration, it returns a Redirect to an external - Sourcegraph URL that may have this repository instead. - Otherwise, this query returns null. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - RepositoryRedirect - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String - - - - {" "} - Query the repository by name, for example - "github.com/gorilla/mux".{" "} -
- - cloneURL - {" "} - -{" "} - - - String - - - - {" "} - Query the repository by a Git clone URL (format - documented here:{" "} - - https://git-scm.com/docs/git-clone_git_urls_a_id_urls_a - - ) by checking for a code host configuration that - matches the clone URL. Will not actually check the - code host to see if the repository actually exists.{" "} -
- - hashedName - {" "} - -{" "} - - - String - - - - {" "} - Query the repository by hashed name. Hashed name is a - SHA256 checksum of the absolute repo name in lower - case, for example "github.com/sourcegraph/sourcegraph" - -> - "a6c905ceb7dec9a565945ceded8c7fa4154250df8b928fb40673b535d9a24c2f"{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    repositoryRedirect
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $cloneURL:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $hashedName:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        repositoryRedirect
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}cloneURL:{" "}
-                                          $cloneURL,
-                                          {"\n"}
-                                          {"    "}hashedName:{" "}
-                                          $hashedName
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on Repository{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on Redirect{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RedirectFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cloneURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hashedName"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "repositoryRedirect"
-                                  :{" "}
-                                  Repository
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- repositoryStats -

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: Query repository statistics for the - site. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - RepositoryStats! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    repositoryStats{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        repositoryStats{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          gitDirBytes
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            indexedLinesCount
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          total
-                                          {"\n"}
-                                          {"    "}
-                                          cloned
-                                          {"\n"}
-                                          {"    "}
-                                          cloning
-                                          {"\n"}
-                                          {"    "}
-                                          notCloned
-                                          {"\n"}
-                                          {"    "}
-                                          failedFetch
-                                          {"\n"}
-                                          {"    "}
-                                          indexed
-                                          {"\n"}
-                                          {"    "}
-                                          corrupted
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "repositoryStats"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "gitDirBytes"
-                                  :{" "}
-                                  {"{"}
-                                  {"}"}
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "indexedLinesCount"
-                                  :{" "}
-                                  {"{"}
-                                  {"}"}
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "total"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "cloned"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "cloning"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notCloned"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "failedFetch"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "indexed"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "corrupted"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- root -

-
-
-
-
- {" "} - this will be removed.{" "} -
-
-
-
-
-
-
-
Description
-

The root of the query.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Query! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query root{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        root{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            root{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...QueryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            node{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NodeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            repository{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            repositoryRedirect{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on Repository{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...RepositoryFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on Redirect{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...RedirectFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                externalServices{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...ExternalServiceConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                externalServiceNamespaces{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...ExternalServiceNamespaceConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                repositories{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...NewRepositoryConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                packageRepoReferences{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...PackageRepoReferenceConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                phabricatorRepo{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...PhabricatorRepoFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                currentUser{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...UserFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                user{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...UserFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                users{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...UserConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                organization{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...OrgFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                organizations{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...OrgConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                renderMarkdown
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                highlightCode
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                settingsSubject{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SettingsSubjectFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                viewerSettings{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SettingsCascadeFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                viewerConfiguration{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...ConfigurationCascadeFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                clientConfiguration{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...ClientConfigurationDetailsFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                search{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SearchFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                savedSearches{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SavedSearchesConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                parseSearchQuery
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                site{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SiteFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                surveyResponses{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SurveyResponseConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                extensionRegistry{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...ExtensionRegistryFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                statusMessages{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"     "}
-                                                  
-                                                    {" "}
-                                                    ... on GitUpdatesDisabled{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"        "}
-                                                      
-                                                        ...GitUpdatesDisabledFragment
-                                                      
-                                                      {"\n"}
-                                                      {"      "}
-                                                      {"}"}
-                                                    
-                                                    {"\n"}
-                                                    {"      "}... on CloningProgress{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"        "}
-                                                      
-                                                        ...CloningProgressFragment
-                                                      
-                                                      {"\n"}
-                                                      {"      "}
-                                                      {"}"}
-                                                    
-                                                    {"\n"}
-                                                    {"      "}... on
-                                                    ExternalServiceSyncError{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"        "}
-                                                      
-                                                        ...ExternalServiceSyncErrorFragment
-                                                      
-                                                      {"\n"}
-                                                      {"      "}
-                                                      {"}"}
-                                                    
-                                                    {"\n"}
-                                                    {"      "}... on SyncError{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"        "}
-                                                      
-                                                        ...SyncErrorFragment
-                                                      
-                                                      {"\n"}
-                                                      {"      "}
-                                                      {"}"}
-                                                    
-                                                    {"\n"}
-                                                    {"      "}... on IndexingProgress{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"        "}
-                                                      
-                                                        ...IndexingProgressFragment
-                                                      
-                                                      {"\n"}
-                                                      {"      "}
-                                                      {"}"}
-                                                    
-                                                    {"\n"}
-                                                    {"    "}
-                                                    {"}"}
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    repositoryStats{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"      "}
-                                                      
-                                                        ...RepositoryStatsFragment
-                                                      
-                                                      {"\n"}
-                                                      {"    "}
-                                                      {"}"}
-                                                    
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    namespace{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"      "}
-                                                      
-                                                        ...NamespaceFragment
-                                                      
-                                                      {"\n"}
-                                                      {"    "}
-                                                      {"}"}
-                                                    
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    namespaceByName{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"      "}
-                                                      
-                                                        ...NamespaceFragment
-                                                      
-                                                      {"\n"}
-                                                      {"    "}
-                                                      {"}"}
-                                                    
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    codeHostSyncDue
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    outOfBandMigrations{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"      "}
-                                                      
-                                                        ...OutOfBandMigrationFragment
-                                                      
-                                                      {"\n"}
-                                                      {"    "}
-                                                      {"}"}
-                                                    
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  
-                                                    featureFlags{" "}
-                                                    
-                                                      {"{"}
-                                                      {"\n"}
-                                                      {"     "}
-                                                      
-                                                        {" "}
-                                                        ... on FeatureFlagBoolean{" "}
-                                                        
-                                                          {"{"}
-                                                          {"\n"}
-                                                          {"        "}
-                                                          
-                                                            ...FeatureFlagBooleanFragment
-                                                          
-                                                          {"\n"}
-                                                          {"      "}
-                                                          {"}"}
-                                                        
-                                                        {"\n"}
-                                                        {"      "}... on FeatureFlagRollout{" "}
-                                                        
-                                                          {"{"}
-                                                          {"\n"}
-                                                          {"        "}
-                                                          
-                                                            ...FeatureFlagRolloutFragment
-                                                          
-                                                          {"\n"}
-                                                          {"      "}
-                                                          {"}"}
-                                                        
-                                                        {"\n"}
-                                                        {"    "}
-                                                        {"}"}
-                                                      
-                                                      {"\n"}
-                                                      {"    "}
-                                                      
-                                                        featureFlag{" "}
-                                                        
-                                                          {"{"}
-                                                          {"\n"}
-                                                          {"     "}
-                                                          
-                                                            {" "}
-                                                            ... on FeatureFlagBoolean{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"        "}
-                                                              
-                                                                ...FeatureFlagBooleanFragment
-                                                              
-                                                              {"\n"}
-                                                              {"      "}
-                                                              {"}"}
-                                                            
-                                                            {"\n"}
-                                                            {"      "}... on
-                                                            FeatureFlagRollout{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"        "}
-                                                              
-                                                                ...FeatureFlagRolloutFragment
-                                                              
-                                                              {"\n"}
-                                                              {"      "}
-                                                              {"}"}
-                                                            
-                                                            {"\n"}
-                                                            {"    "}
-                                                            {"}"}
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            evaluateFeatureFlag
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            evaluatedFeatureFlags{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...EvaluatedFeatureFlagFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            organizationFeatureFlagValue
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            organizationFeatureFlagOverrides{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...FeatureFlagOverrideFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            temporarySettings{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...TemporarySettingsFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            webhookLogs{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...WebhookLogConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            outboundRequests{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...OutboundRequestConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            backgroundJobs{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...BackgroundJobConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            invitationByToken{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...OrganizationInvitationFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            pendingInvitations{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...OrganizationInvitationFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            autocompleteMembersSearch{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...AutocompleteMemberSearchItemFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            orgMembersSummary{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...OrgMembersSummaryFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            webhooks{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...WebhookConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            slowRequests{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...SlowRequestConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            executorSecrets{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...ExecutorSecretConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            executors{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...ExecutorConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            areExecutorsConfigured
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            team{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...TeamFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"    "}
-                                                          
-                                                            teams{" "}
-                                                            
-                                                              {"{"}
-                                                              {"\n"}
-                                                              {"      "}
-                                                              
-                                                                ...TeamConnectionFragment
-                                                              
-                                                              {"\n"}
-                                                              {"    "}
-                                                              {"}"}
-                                                            
-                                                          
-                                                          {"\n"}
-                                                          {"  "}
-                                                          {"}"}
-                                                        
-                                                      
-                                                      {"\n"}
-                                                      {"}"}
-                                                    
-                                                  
-                                                
-                                              
-                                            
-                                          
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "root"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "root"
-                                  :{" "}
-                                  Query
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "node"
-                                  :{" "}
-                                  Node
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repositoryRedirect"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalServices"
-                                  :{" "}
-                                  
-                                    ExternalServiceConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "externalServiceNamespaces"
-                                  
-                                  :{" "}
-                                  
-                                    ExternalServiceNamespaceConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repositories"
-                                  :{" "}
-                                  
-                                    NewRepositoryConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "packageRepoReferences"
-                                  :{" "}
-                                  
-                                    PackageRepoReferenceConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "phabricatorRepo"
-                                  :{" "}
-                                  PhabricatorRepo
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "currentUser"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "users"
-                                  :{" "}
-                                  UserConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organization"
-                                  :{" "}
-                                  Org
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organizations"
-                                  :{" "}
-                                  OrgConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "renderMarkdown"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "highlightCode"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsSubject"
-                                  :{" "}
-                                  SettingsSubject
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerSettings"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerConfiguration"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "clientConfiguration"
-                                  :{" "}
-                                  
-                                    ClientConfigurationDetails
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "search"
-                                  :{" "}
-                                  Search
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "savedSearches"
-                                  :{" "}
-                                  
-                                    SavedSearchesConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parseSearchQuery"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "site"
-                                  :{" "}
-                                  Site
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "surveyResponses"
-                                  :{" "}
-                                  
-                                    SurveyResponseConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "extensionRegistry"
-                                  :{" "}
-                                  ExtensionRegistry
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "statusMessages"
-                                  :{" "}
-                                  [
-                                  GitUpdatesDisabled
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repositoryStats"
-                                  :{" "}
-                                  RepositoryStats
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceByName"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "codeHostSyncDue"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "outOfBandMigrations"
-                                  :{" "}
-                                  [
-                                  OutOfBandMigration
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "featureFlags"
-                                  :{" "}
-                                  [
-                                  FeatureFlagBoolean
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "featureFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "evaluateFeatureFlag"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "evaluatedFeatureFlags"
-                                  :{" "}
-                                  [
-                                  EvaluatedFeatureFlag
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "organizationFeatureFlagValue"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "organizationFeatureFlagOverrides"
-                                  
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"        "}
-                                  FeatureFlagOverride
-                                  {"\n"}
-                                  {"      "}
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "temporarySettings"
-                                  :{" "}
-                                  TemporarySettings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "outboundRequests"
-                                  :{" "}
-                                  
-                                    OutboundRequestConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "backgroundJobs"
-                                  :{" "}
-                                  
-                                    BackgroundJobConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "invitationByToken"
-                                  :{" "}
-                                  
-                                    OrganizationInvitation
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pendingInvitations"
-                                  :{" "}
-                                  [
-                                  
-                                    OrganizationInvitation
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "autocompleteMembersSearch"
-                                  
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"        "}
-                                  
-                                    AutocompleteMemberSearchItem
-                                  
-                                  {"\n"}
-                                  {"      "}
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "orgMembersSummary"
-                                  :{" "}
-                                  OrgMembersSummary
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhooks"
-                                  :{" "}
-                                  WebhookConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "slowRequests"
-                                  :{" "}
-                                  SlowRequestConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "executors"
-                                  :{" "}
-                                  ExecutorConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "areExecutorsConfigured"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "team"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "teams"
-                                  :{" "}
-                                  TeamConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- savedSearches -

-
-
-
-
Description
-

List of saved searches based on namespace

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SavedSearchesConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - namespace - {" "} - -{" "} - - - ID! - - - The namespace to list the saved searches for.
- - first - {" "} - -{" "} - - - Int - - - The limit argument for forward pagination.
- - last - {" "} - -{" "} - - - Int - - - The limit argument for backward pagination.
- - after - {" "} - -{" "} - - - String - - - The cursor argument for forward pagination.
- - before - {" "} - -{" "} - - - String - - - The cursor argument for backward pagination.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    savedSearches
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $namespace: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $last:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $before:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        savedSearches
-                                        
-                                          ({"\n"}
-                                          {"    "}namespace:{" "}
-                                          $namespace,
-                                          {"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}last:{" "}
-                                          $last,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}before:{" "}
-                                          $before
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SavedSearchFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConnectionPageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "last"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "before"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "savedSearches"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  SavedSearch
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  ConnectionPageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
- -
-
- Queries -
-

- settingsSubject -

-
-
-
-
Description
-

- Looks up an instance of a type that implements - SettingsSubject (i.e., something that has settings). This - can be a site (which has global settings), an organization, - or a user. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SettingsSubject - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    settingsSubject
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        settingsSubject
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "settingsSubject"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- site -

-
-
-
-
Description
-

The current site.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Site! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query site{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        site{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          siteID
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configuration{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SiteConfigurationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          canReloadSite
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessTokens{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AccessTokenConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            authProviders{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AuthProviderConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalAccounts{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalAccountConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          buildVersion
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            productVersion
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            updateCheck{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateCheckFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            needsRepositoryConfiguration
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalServicesFromFile
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            allowEditExternalServicesWithFile
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            freeUsersExceeded
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            alerts{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AlertFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            hasCodeIntelligence
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            sendsEmailVerificationEmails
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            productSubscription{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ProductSubscriptionStatusFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            usageStatistics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SiteUsageStatisticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            analytics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AnalyticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            users{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SiteUsersFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            monitoringStatistics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...MonitoringStatisticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            allowSiteSettingsEdits
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            enableLegacyExtensions
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            upgradeReadiness{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpgradeReadinessFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "site"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "siteID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configuration"
-                                  :{" "}
-                                  SiteConfiguration
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "canReloadSite"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessTokens"
-                                  :{" "}
-                                  AccessTokenConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "authProviders"
-                                  :{" "}
-                                  
-                                    AuthProviderConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalAccounts"
-                                  :{" "}
-                                  
-                                    ExternalAccountConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "buildVersion"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "productVersion"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updateCheck"
-                                  :{" "}
-                                  UpdateCheck
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "needsRepositoryConfiguration"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "externalServicesFromFile"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "allowEditExternalServicesWithFile"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "freeUsersExceeded"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "alerts"
-                                  :{" "}
-                                  [
-                                  Alert
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "hasCodeIntelligence"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "sendsEmailVerificationEmails"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "productSubscription"
-                                  :{" "}
-                                  
-                                    ProductSubscriptionStatus
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "usageStatistics"
-                                  :{" "}
-                                  SiteUsageStatistics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "analytics"
-                                  :{" "}
-                                  Analytics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "users"
-                                  :{" "}
-                                  SiteUsers
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "monitoringStatistics"
-                                  :{" "}
-                                  MonitoringStatistics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "allowSiteSettingsEdits"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "enableLegacyExtensions"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "upgradeReadiness"
-                                  :{" "}
-                                  UpgradeReadiness
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- slowRequests -

-
-
-
-
Description
-

- List slow GraphQL requests that were recently captured - (requires site-admin permissions). -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SlowRequestConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - after - {" "} - -{" "} - - - String - - - Opaque pagnination cursor.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query slowRequests
-                                    
-                                      ($after:
-                                       String) {"{"}
-                                      {"\n"}
-                                      {"  "}slowRequests(after:{" "}
-                                      $after)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"    "}
-                                      
-                                        nodes{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"      "}
-                                          
-                                            ...SlowRequestFragment
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"    "}
-                                      totalCount
-                                      {"\n"}
-                                      {"    "}
-                                      
-                                        pageInfo{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"      "}
-                                          
-                                            ...PageInfoFragment
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"  "}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "slowRequests"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  SlowRequest
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- statusMessages -

-
-
-
-
Description
-

FOR INTERNAL USE ONLY: Lists all status messages

-
-
-
-
-
-
-
Response
-

- {" "} - Returns{" "} - - [StatusMessage!]! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    statusMessages{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        statusMessages{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on GitUpdatesDisabled{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitUpdatesDisabledFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on CloningProgress{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...CloningProgressFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on ExternalServiceSyncError{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceSyncErrorFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on SyncError{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SyncErrorFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on IndexingProgress{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...IndexingProgressFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "statusMessages"
-                                  :{" "}
-                                  [
-                                  GitUpdatesDisabled
-                                  ]
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- surveyResponses -

-
-
-
-
Description
-

Retrieve responses to surveys.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SurveyResponseConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - - {" "} - Returns the first n survey responses from the list.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    surveyResponses
-                                    
-                                      ($first:
-                                       Int) {"{"}
-                                      {"\n"}
-                                      {"  "}surveyResponses(first:{" "}
-                                      $first)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"    "}
-                                      
-                                        nodes{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"      "}
-                                          
-                                            ...SurveyResponseFragment
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"    "}
-                                      totalCount
-                                      {"\n"}
-                                      {"    "}
-                                      last30DaysCount
-                                      {"\n"}
-                                      {"    "}
-                                      averageScore
-                                      {"\n"}
-                                      {"    "}
-                                      netPromoterScore
-                                      {"\n"}
-                                      {"  "}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "surveyResponses"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  SurveyResponse
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "last30DaysCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "averageScore"
-                                  :{" "}
-                                  987.65
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "netPromoterScore"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- team -

-
-
-
-
Description
-

Get a single team by name. Returns null if not found.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query team
-                                    
-                                      ($name:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        team
-                                        
-                                          (name: $name)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "team"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- teams -

-
-
-
-
Description
-

- Get the global list of all root teams. (Those without a - parent team). -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - TeamConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - Returns the first n teams from the list.
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
- - search - {" "} - -{" "} - - - String - - - - {" "} - Search can be used to do a text-search over the team - names.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query teams
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $search:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        teams
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}search:{" "}
-                                          $search
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "search"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "teams"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Team
-                                  ]
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- temporarySettings -

-
-
-
-
Description
-

Retrieves the temporary settings for the current user.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - TemporarySettings! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    temporarySettings{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        temporarySettings{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          contents
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "temporarySettings"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "contents"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- user -

-
-
-
-
Description
-

Looks up a user by username or email address.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - User - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - username - {" "} - -{" "} - - - String - - - Query the user by username.
- - email - {" "} - -{" "} - - - String - - - Query the user by verified email address.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query user
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $username:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $email:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        user
-                                        
-                                          ({"\n"}
-                                          {"    "}username:{" "}
-                                          $username,
-                                          {"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          username
-                                          {"\n"}
-                                          {"    "}
-                                          email
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          avatarURL
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          siteAdmin
-                                          {"\n"}
-                                          {"    "}
-                                          builtinAuth
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizations{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizationMemberships{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationMembershipConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          tags
-                                          {"\n"}
-                                          {"    "}
-                                          tosAccepted
-                                          {"\n"}
-                                          {"    "}
-                                          searchable
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            usageStatistics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserUsageStatisticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            eventLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...EventLogsConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            emails{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserEmailFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessTokens{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AccessTokenConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalAccounts{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalAccountConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            session{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SessionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanChangeUsername
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            surveyResponses{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SurveyResponseFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          databaseID
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            invitableCollaborators{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PersonFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            teams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "user"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "username"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "siteAdmin"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "builtinAuth"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organizations"
-                                  :{" "}
-                                  OrgConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "organizationMemberships"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationMembershipConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tags"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tosAccepted"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "searchable"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "usageStatistics"
-                                  :{" "}
-                                  UserUsageStatistics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "eventLogs"
-                                  :{" "}
-                                  EventLogsConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "emails"
-                                  :{" "}
-                                  [
-                                  UserEmail
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessTokens"
-                                  :{" "}
-                                  AccessTokenConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalAccounts"
-                                  :{" "}
-                                  
-                                    ExternalAccountConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "session"
-                                  :{" "}
-                                  Session
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerCanChangeUsername"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "surveyResponses"
-                                  :{" "}
-                                  [
-                                  SurveyResponse
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "databaseID"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "invitableCollaborators"
-                                  
-                                  :{" "}
-                                  [
-                                  Person
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "teams"
-                                  :{" "}
-                                  TeamConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- users -

-
-
-
-
Description
-

List all users.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - UserConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - Returns the first n users from the list.
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
- - query - {" "} - -{" "} - - - String - - - - {" "} - Return users whose usernames or display names match - the query.{" "} -
- - tag - {" "} - -{" "} - - - String - - - Return only users with the given tag.
- - activePeriod - {" "} - -{" "} - - - UserActivePeriod - - - - {" "} - Returns users who have been active in a given period - of time.{" "} -
- - inactiveSince - {" "} - -{" "} - - - DateTime - - - - {" "} - Returns users who have NOT been active since a given - point in time.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query users
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $query:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $tag:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $activePeriod:
-                                       UserActivePeriod,
-                                      {"\n"}
-                                      {"  "}
-                                      $inactiveSince:
-                                       DateTime{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        users
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}tag:{" "}
-                                          $tag,{"\n"}
-                                          {"    "}activePeriod:{" "}
-                                          $activePeriod,
-                                          {"\n"}
-                                          {"    "}inactiveSince:{" "}
-                                          $inactiveSince
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "tag"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "activePeriod"
-                                  :{" "}
-                                  "TODAY"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "inactiveSince"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "users"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  User
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- viewerConfiguration -

-
-
-
-
- {" "} - use viewerSettings instead{" "} -
-
-
-
-
-
-
-
Description
-

DEPRECATED

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - ConfigurationCascade! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    viewerConfiguration{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        viewerConfiguration{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            subjects{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsSubjectFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            merged{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "viewerConfiguration"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "subjects"
-                                  :{" "}
-                                  [
-                                  SettingsSubject
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "merged"
-                                  :{" "}
-                                  Configuration
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- viewerSettings -

-
-
-
-
Description
-

- The settings for the viewer. The viewer is either an - anonymous visitor (in which case viewer settings is global - settings) or an authenticated user (in which case viewer - settings are the user's settings). -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SettingsCascade! - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query{" "}
-                                    viewerSettings{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        viewerSettings{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            subjects{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsSubjectFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          final
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            merged{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "viewerSettings"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "subjects"
-                                  :{" "}
-                                  [
-                                  SettingsSubject
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "final"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "merged"
-                                  :{" "}
-                                  Configuration
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- webhookLogs -

-
-
-
-
Description
-

- Returns recently received webhooks across all external - services, optionally limiting the returned values to only - those that didn't match any external service. -

-

Only site admins can access this field.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - WebhookLogConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - Returns the first n webhook logs.
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
- - onlyErrors - {" "} - -{" "} - - - Boolean - - - - {" "} - Only include webhook logs that resulted in errors.{" "} -
- - onlyUnmatched - {" "} - -{" "} - - - Boolean - - - - {" "} - Only include webhook logs that were not matched to an - external service.{" "} -
- - since - {" "} - -{" "} - - - DateTime - - - - {" "} - Only include webhook logs on or after this time.{" "} -
- - until - {" "} - -{" "} - - - DateTime - - - - {" "} - Only include webhook logs on or before this time.{" "} -
- - webhookID - {" "} - -{" "} - - - ID - - - - {" "} - Only include webhook logs of given webhook ID.{" "} -
- - legacyOnly - {" "} - -{" "} - - - Boolean - - - - {" "} - Only include webhook logs that have no webhook ID set.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query webhookLogs
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $onlyErrors:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $onlyUnmatched:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $since:
-                                       DateTime,
-                                      {"\n"}
-                                      {"  "}
-                                      $until:
-                                       DateTime,
-                                      {"\n"}
-                                      {"  "}
-                                      $webhookID: ID,
-                                      {"\n"}
-                                      {"  "}
-                                      $legacyOnly:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        webhookLogs
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}onlyErrors:{" "}
-                                          $onlyErrors,
-                                          {"\n"}
-                                          {"    "}onlyUnmatched:{" "}
-                                          $onlyUnmatched,
-                                          {"\n"}
-                                          {"    "}since:{" "}
-                                          $since,{"\n"}
-                                          {"    "}until:{" "}
-                                          $until,{"\n"}
-                                          {"    "}webhookID:{" "}
-                                          $webhookID,
-                                          {"\n"}
-                                          {"    "}legacyOnly:{" "}
-                                          $legacyOnly
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookLogFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "onlyErrors"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "onlyUnmatched"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "since"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "until"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "webhookID"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "legacyOnly"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  WebhookLog
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Queries -
-

- webhooks -

-
-
-
-
Description
-

- Lists webhooks. Only available to site admins. If no kind is - given, it returns all webhooks. If first is omitted, 20 - items are returned -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - WebhookConnection! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - first - {" "} - -{" "} - - - Int - - - Returns the first n webhooks from the list.
- - after - {" "} - -{" "} - - - String - - - Opaque pagination cursor.
- - kind - {" "} - -{" "} - - - ExternalServiceKind - - - Optionally filter by kind.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    query webhooks
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $first:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $after:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $kind:
-                                      
-                                        {" "}
-                                        ExternalServiceKind{"\n"}
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        webhooks
-                                        
-                                          ({"\n"}
-                                          {"    "}first:{" "}
-                                          $first,{"\n"}
-                                          {"    "}after:{" "}
-                                          $after,{"\n"}
-                                          {"    "}kind:{" "}
-                                          $kind
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            nodes{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          totalCount
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            pageInfo{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PageInfoFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "first"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "after"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "webhooks"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Webhook
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-

- Mutations -

-
-

- addExternalAccount -

-
-
-
-
Description
-

- Adds an external account to the authenticated user's - account. The service type and service ID must correspond to - a valid auth provider on the site. The account details must - be a stringified JSON object that contains valid credentials - for the provided service type. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - serviceType - {" "} - -{" "} - - - String! - - -
- - serviceID - {" "} - -{" "} - - - String! - - -
- - accountDetails - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addExternalAccount
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $serviceType:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $serviceID:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $accountDetails:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addExternalAccount
-                                        
-                                          ({"\n"}
-                                          {"    "}serviceType:{" "}
-                                          $serviceType,
-                                          {"\n"}
-                                          {"    "}serviceID:{" "}
-                                          $serviceID,
-                                          {"\n"}
-                                          {"    "}accountDetails:{" "}
-                                          $accountDetails
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceType"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "accountDetails"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addExternalAccount"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addExternalService -

-
-
-
-
Description
-

- Adds a external service. Only site admins may perform this - mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExternalService! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - AddExternalServiceInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addExternalService
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        AddExternalServiceInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addExternalService
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          kind
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          config
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          repoCount
-                                          {"\n"}
-                                          {"    "}
-                                          webhookURL
-                                          {"\n"}
-                                          {"    "}
-                                          warning
-                                          {"\n"}
-                                          {"    "}
-                                          lastSyncError
-                                          {"\n"}
-                                          {"    "}
-                                          lastSyncAt
-                                          {"\n"}
-                                          {"    "}
-                                          nextSyncAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            webhookLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            syncJobs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceSyncJobConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            checkConnection{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on ExternalServiceAvailable{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceAvailableFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on ExternalServiceUnavailable{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceUnavailableFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on
-                                                ExternalServiceAvailabilityUnknown{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceAvailabilityUnknownFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                hasConnectionCheck
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                supportsRepoExclusion
-                                              
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  
-                                    AddExternalServiceInput
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addExternalService"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "config"
-                                  :{" "}
-                                  JSONCString
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repoCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "warning"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "lastSyncError"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "lastSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "nextSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "syncJobs"
-                                  :{" "}
-                                  
-                                    ExternalServiceSyncJobConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "checkConnection"
-                                  :{" "}
-                                  
-                                    ExternalServiceAvailable
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "hasConnectionCheck"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "supportsRepoExclusion"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addPhabricatorRepo -

-
-
-
-
Description
-

Adds a Phabricator repository to Sourcegraph.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - callsign - {" "} - -{" "} - - - String! - - - The callsign, for example "MUX".
- - name - {" "} - -{" "} - - - String - - - - {" "} - The name, for example "github.com/gorilla/mux".{" "} -
- - uri - {" "} - -{" "} - - - String - - - - {" "} - An alias for name. DEPRECATED: use name instead.{" "} -
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to the phabricator instance (e.g.{" "} - - http://phabricator.sgdev.org - - ).{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addPhabricatorRepo
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $callsign:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $uri:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $url:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addPhabricatorRepo
-                                        
-                                          ({"\n"}
-                                          {"    "}callsign:{" "}
-                                          $callsign,
-                                          {"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}uri:{" "}
-                                          $uri,{"\n"}
-                                          {"    "}url:{" "}
-                                          $url
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "callsign"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "uri"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addPhabricatorRepo"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addRepoKeyValuePair -

-
-
-
-
Description
-

Associate a new key-value pair with a repo.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - repo - {" "} - -{" "} - - - ID! - - -
- - key - {" "} - -{" "} - - - String! - - -
- - value - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addRepoKeyValuePair
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $repo: ID!,{"\n"}
-                                      {"  "}
-                                      $key:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addRepoKeyValuePair
-                                        
-                                          ({"\n"}
-                                          {"    "}repo:{" "}
-                                          $repo,{"\n"}
-                                          {"    "}key:{" "}
-                                          $key,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "repo"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "key"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addRepoKeyValuePair"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addTeamMembers -

-
-
-
-
Description
-

- Add a list of team members to an existing team. People that - already are part of the team are ignored. -

-

- Either team XOR teamName can be specified to specify the - team. Must be team member to add new team members, or - site-admin. -

-

- For now, members can only be the IDs of User entities in - Sourcegraph. Later, we will expand this to allow Persons as - well. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - team - {" "} - -{" "} - - - ID - - -
- - teamName - {" "} - -{" "} - - - String - - -
- - members - {" "} - -{" "} - - - [ID!]! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addTeamMembers
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $team: ID,{"\n"}
-                                      {"  "}
-                                      $teamName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $members: [ID!]!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addTeamMembers
-                                        
-                                          ({"\n"}
-                                          {"    "}team:{" "}
-                                          $team,{"\n"}
-                                          {"    "}teamName:{" "}
-                                          $teamName,
-                                          {"\n"}
-                                          {"    "}members:{" "}
-                                          $members
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "team"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "teamName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "members"
-                                  :{" "}
-                                  [
-                                  "4"
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addTeamMembers"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addUserEmail -

-
-
-
-
Description
-

- Adds an email address to the user's account. The email - address will be marked as unverified until the user has - followed the email verification process. -

-

- Only the user and site admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - email - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addUserEmail
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addUserEmail
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addUserEmail"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- addUserToOrganization -

-
-
-
-
Description
-

- Immediately add a user as a member to the organization, - without sending an invitation email. -

-

- Only site admins may perform this mutation. Organization - members may use the inviteUserToOrganization mutation to - invite users. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - -
- - username - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    addUserToOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $organization: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $username:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        addUserToOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}organization:{" "}
-                                          $organization,
-                                          {"\n"}
-                                          {"    "}username:{" "}
-                                          $username
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "addUserToOrganization"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- cancelExternalServiceSync -

-
-
-
-
Description
-

- Cancels an external service sync job. Must be in queued or - processing state. -

-

Site-admin or owner of the external service only.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    cancelExternalServiceSync
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        cancelExternalServiceSync
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "cancelExternalServiceSync"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- checkMirrorRepositoryConnection -

-
-
-
-
Description
-

- Tests the connection to a mirror repository's original - source repository. This is an expensive and slow operation, - so it should only be used for interactive diagnostics. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - CheckMirrorRepositoryConnectionResult! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - repository - {" "} - -{" "} - - - ID - - - - {" "} - The ID of the existing repository whose mirror to - check.{" "} -
- - name - {" "} - -{" "} - - - String - - - - {" "} - The name of a repository whose mirror to check. If the - name is provided, the repository need not be added to - the site (but the site configuration must define a - code host that knows how to handle the name).{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    checkMirrorRepositoryConnection
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $repository: ID,
-                                      {"\n"}
-                                      {"  "}
-                                      $name:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        checkMirrorRepositoryConnection
-                                        
-                                          ({"\n"}
-                                          {"    "}repository:{" "}
-                                          $repository,
-                                          {"\n"}
-                                          {"    "}name:{" "}
-                                          $name
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          error
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "repository"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "checkMirrorRepositoryConnection"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "error"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- configurationMutation -

-
-
-
-
- {" "} - use settingsMutation instead{" "} -
-
-
-
-
-
-
-
Description
-

- DEPRECATED: Use settingsMutation instead. This field is a - deprecated alias for settingsMutation and will be removed in - a future release. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SettingsMutation - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - SettingsMutationGroupInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    configurationMutation
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        SettingsMutationGroupInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        configurationMutation
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            editSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            editConfiguration{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            overwriteSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  
-                                    SettingsMutationGroupInput
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "configurationMutation"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "editSettings"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "editConfiguration"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "overwriteSettings"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createAccessToken -

-
-
-
-
Description
-

- Creates an access token that grants the privileges of the - specified user (referred to as the access token's "subject" - user after token creation). The result is the access token - value, which the caller is responsible for storing (it is - not accessible by Sourcegraph after creation). -

-

The supported scopes are:

-
    -
  • - "user:all": Full control of all resources accessible to - the user account. -
    • -
  • - "site-admin:sudo": Ability to perform any action as any - other user. (Only site admins may create tokens with this - scope.) -
    • -
-

Only the user or site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - CreateAccessTokenResult! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - scopes - {" "} - -{" "} - - - [String!]! - - -
- - note - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createAccessToken
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $scopes:{" "}
-                                      [String!]!,{"\n"}
-                                      {"  "}
-                                      $note:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createAccessToken
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}scopes:{" "}
-                                          $scopes,{"\n"}
-                                          {"    "}note:{" "}
-                                          $note
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          token
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "scopes"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "note"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createAccessToken"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "token"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createExecutorSecret -

-
-
-
-
Description
-

- Create a new executor secret. See argument descriptions for - more details. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExecutorSecret! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - - The scope for which the secret is usable.
- - key - {" "} - -{" "} - - - String! - - - - {" "} - The key under which the secret is known. For - executions, this is the name of the environment - variable this secret will be accessible under. It is - therefore advised that key only contains uppercase - letters, numbers and underscores.{" "} -
- - value - {" "} - -{" "} - - - String! - - - The secret value.
- - namespace - {" "} - -{" "} - - - ID - - - - {" "} - The namespace this secret is for. If not set, a global - secret is created that is accessible by all users. - Creating a global secret requires site-admin - permissions. Creating a namespaced secret requires - write-access to the namespace.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createExecutorSecret
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $scope:
-                                      
-                                        {" "}
-                                        ExecutorSecretScope!
-                                      
-                                      ,{"\n"}
-                                      {"  "}
-                                      $key:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $namespace: ID
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createExecutorSecret
-                                        
-                                          ({"\n"}
-                                          {"    "}scope:{" "}
-                                          $scope,{"\n"}
-                                          {"    "}key:{" "}
-                                          $key,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value,{"\n"}
-                                          {"    "}namespace:{" "}
-                                          $namespace
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          key
-                                          {"\n"}
-                                          {"    "}
-                                          scope
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            overwritesGlobalSecret
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            creator{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretAccessLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "key"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  "4"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createExecutorSecret"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "key"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "overwritesGlobalSecret"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "creator"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessLogs"
-                                  :{" "}
-                                  
-                                    ExecutorSecretAccessLogConnection
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createFeatureFlag -

-
-
-
-
Description
-

(experimental) Create a new feature flag

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - FeatureFlag! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
- - value - {" "} - -{" "} - - - Boolean - - - - {" "} - The value of the feature flag. Only set if the new - feature flag will be a concrete boolean flag. Mutually - exclusive with rolloutBasisPoints.{" "} -
- - rolloutBasisPoints - {" "} - -{" "} - - - Int - - - - {" "} - The ratio of users the feature flag will apply to, - expressed in basis points (0.01%). Only set if the new - feature flag will be a rollout flag. Mutually - exclusive with value.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createFeatureFlag
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $rolloutBasisPoints
-                                      : Int{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createFeatureFlag
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value,{"\n"}
-                                          {"    "}rolloutBasisPoints:{" "}
-                                          
-                                            $rolloutBasisPoints
-                                          
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on FeatureFlagBoolean{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagBooleanFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on FeatureFlagRollout{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagRolloutFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "rolloutBasisPoints"
-                                  :{" "}
-                                  987
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "createFeatureFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createFeatureFlagOverride -

-
-
-
-
Description
-

- (experimental) Create a new feature flag override for the - given org or user -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - FeatureFlagOverride! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - namespace - {" "} - -{" "} - - - ID! - - - - {" "} - The namespace for this feature flag. Must be either a - user ID or an org ID.{" "} -
- - flagName - {" "} - -{" "} - - - String! - - - - {" "} - The name of the feature flag this override applies to{" "} -
- - value - {" "} - -{" "} - - - Boolean! - - - The overridden value
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createFeatureFlagOverride
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $namespace: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $flagName:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createFeatureFlagOverride
-                                        
-                                          ({"\n"}
-                                          {"    "}namespace:{" "}
-                                          $namespace,
-                                          {"\n"}
-                                          {"    "}flagName:{" "}
-                                          $flagName,
-                                          {"\n"}
-                                          {"    "}value:{" "}
-                                          $value
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            targetFlag{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on FeatureFlagBoolean{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagBooleanFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on FeatureFlagRollout{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagRolloutFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              value
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "flagName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "createFeatureFlagOverride"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "targetFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createOrganization -

-
-
-
-
Description
-

- Creates an organization. The caller is added as a member of - the newly created organization. -

-

Only authenticated users may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - Org! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
- - displayName - {" "} - -{" "} - - - String - - -
- - statsID - {" "} - -{" "} - - - ID - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $displayName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $statsID: ID{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}displayName:{" "}
-                                          $displayName,
-                                          {"\n"}
-                                          {"    "}statsID:{" "}
-                                          $statsID
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NewUsersConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerPendingInvitation{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationInvitationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerIsMember
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "statsID"
-                                  :{" "}
-                                  "4"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createOrganization"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  NewUsersConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerPendingInvitation"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationInvitation
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerIsMember"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createPassword -

-
-
-
-
Description
-

- Creates a password for the current user. It is only - permitted if the user does not have a password. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - newPassword - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createPassword
-                                    
-                                      ($newPassword:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createPassword
-                                        
-                                          (newPassword:{" "}
-                                          $newPassword)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "newPassword"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createPassword"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createSavedSearch -

-
-
-
-
Description
-

Creates a saved search.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SavedSearch! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - description - {" "} - -{" "} - - - String! - - -
- - query - {" "} - -{" "} - - - String! - - -
- - notifyOwner - {" "} - -{" "} - - - Boolean! - - -
- - notifySlack - {" "} - -{" "} - - - Boolean! - - -
- - orgID - {" "} - -{" "} - - - ID - - -
- - userID - {" "} - -{" "} - - - ID - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createSavedSearch
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $description:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $query:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $notifyOwner:
-                                       Boolean!,{"\n"}
-                                      {"  "}
-                                      $notifySlack:
-                                       Boolean!,{"\n"}
-                                      {"  "}
-                                      $orgID: ID,{"\n"}
-                                      {"  "}
-                                      $userID: ID{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createSavedSearch
-                                        
-                                          ({"\n"}
-                                          {"    "}description:{" "}
-                                          $description,
-                                          {"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}notifyOwner:{" "}
-                                          $notifyOwner,
-                                          {"\n"}
-                                          {"    "}notifySlack:{" "}
-                                          $notifySlack,
-                                          {"\n"}
-                                          {"    "}orgID:{" "}
-                                          $orgID,{"\n"}
-                                          {"    "}userID:{" "}
-                                          $userID
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          description
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            query
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          notify
-                                          {"\n"}
-                                          {"    "}
-                                          notifySlack
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            slackWebhookURL
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "description"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notifyOwner"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notifySlack"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "orgID"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "userID"
-                                  :{" "}
-                                  4
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createSavedSearch"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "description"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "query"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notify"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notifySlack"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "slackWebhookURL"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createTeam -

-
-
-
-
Description
-

- Creates a team. The name must be unique, display name can be - used to set a custom display value for the team inside - Sourcegraph. -

-

- If readonly is true, the Sourcegraph UI will show a warning - banner that this team is managed externally, and it can only - be modified by site-admins. This is to prevent state drift - from external systems that ingest team information into - Sourcegraph. Readonly can only be set by site-admins. -

-

- Either parentTeam XOR parentTeamName can be specified to - make the team a child team of the given parent. Only members - of the parent team or site-admis can create a child team. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
- - displayName - {" "} - -{" "} - - - String - - -
- - readonly - {" "} - -{" "} - - - Boolean - - - - {" "} - Default = false{" "} -
- - parentTeam - {" "} - -{" "} - - - ID - - -
- - parentTeamName - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createTeam
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $displayName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $readonly:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $parentTeam: ID,
-                                      {"\n"}
-                                      {"  "}
-                                      $parentTeamName:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createTeam
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}displayName:{" "}
-                                          $displayName,
-                                          {"\n"}
-                                          {"    "}readonly:{" "}
-                                          $readonly,
-                                          {"\n"}
-                                          {"    "}parentTeam:{" "}
-                                          $parentTeam,
-                                          {"\n"}
-                                          {"    "}parentTeamName:{" "}
-                                          $parentTeamName
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parentTeam"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parentTeamName"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createTeam"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createUser -

-
-
-
-
Description
-

Creates a new user account.

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - CreateUserResult! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - username - {" "} - -{" "} - - - String! - - - The new user's username.
- - email - {" "} - -{" "} - - - String - - - - {" "} - The new user's optional email address. If given, it - must be verified by the user.{" "} -
- - verifiedEmail - {" "} - -{" "} - - - Boolean - - - - {" "} - Whether or not to mark the provided email address as - verified. If unset or set to true, then the email - address is immediately marked as verified - otherwise, - the email may be marked as unverified if SMTP and - password resets are enabled.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createUser
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $username:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $verifiedEmail:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createUser
-                                        
-                                          ({"\n"}
-                                          {"    "}username:{" "}
-                                          $username,
-                                          {"\n"}
-                                          {"    "}email:{" "}
-                                          $email,{"\n"}
-                                          {"    "}verifiedEmail:{" "}
-                                          $verifiedEmail
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            user{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            resetPasswordURL
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "verifiedEmail"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createUser"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "resetPasswordURL"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- createWebhook -

-
-
-
-
Description
-

- Creates a webhook for the specified code host. Only site - admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Webhook! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - -
- - codeHostKind - {" "} - -{" "} - - - String! - - -
- - codeHostURN - {" "} - -{" "} - - - String! - - -
- - secret - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    createWebhook
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $codeHostKind:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $codeHostURN:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $secret:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        createWebhook
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}codeHostKind:{" "}
-                                          $codeHostKind,
-                                          {"\n"}
-                                          {"    "}codeHostURN:{" "}
-                                          $codeHostURN,
-                                          {"\n"}
-                                          {"    "}secret:{" "}
-                                          $secret
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          uuid
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          codeHostKind
-                                          {"\n"}
-                                          {"    "}
-                                          codeHostURN
-                                          {"\n"}
-                                          {"    "}
-                                          secret
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            updatedBy{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            createdBy{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            webhookLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeHostKind"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeHostURN"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "secret"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "createWebhook"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "uuid"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "codeHostKind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "codeHostURN"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "secret"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedBy"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdBy"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteAccessToken -

-
-
-
-
Description
-

- Deletes and immediately revokes the specified access token, - specified by either its ID or by the token itself. -

-

- Only site admins or the user who owns the token may perform - this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - byID - {" "} - -{" "} - - - ID - - -
- - byToken - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteAccessToken
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $byID: ID,{"\n"}
-                                      {"  "}
-                                      $byToken:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteAccessToken
-                                        
-                                          ({"\n"}
-                                          {"    "}byID:{" "}
-                                          $byID,{"\n"}
-                                          {"    "}byToken:{" "}
-                                          $byToken
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "byID"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "byToken"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteAccessToken"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteExecutorSecret -

-
-
-
-
Description
-

Deletes the given executor secret.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - - The scope of the secret.
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - The identifier of the secret that shall be deleted.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteExecutorSecret
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $scope:
-                                      
-                                        {" "}
-                                        ExecutorSecretScope!
-                                      
-                                      ,{"\n"}
-                                      {"  "}
-                                      $id: ID!{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteExecutorSecret
-                                        
-                                          ({"\n"}
-                                          {"    "}scope:{" "}
-                                          $scope,{"\n"}
-                                          {"    "}id: $id
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,{" "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteExecutorSecret"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteExternalAccount -

-
-
-
-
Description
-

- Deletes the association between an external account and its - Sourcegraph user. It does NOT delete the external account on - the external service where it resides. -

-

- Only site admins or the user who is associated with the - external account may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - externalAccount - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteExternalAccount
-                                    
-                                      ($externalAccount:
-                                      ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteExternalAccount
-                                        
-                                          (externalAccount:{" "}
-                                          
-                                            $externalAccount
-                                          
-                                          )
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "externalAccount"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteExternalAccount"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteExternalService -

-
-
-
-
Description
-

- Delete an external service. Only site admins may perform - this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - externalService - {" "} - -{" "} - - - ID! - - -
- - async - {" "} - -{" "} - - - Boolean - - - - {" "} - Default = false{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteExternalService
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $externalService:
-                                      ID!,{"\n"}
-                                      {"  "}
-                                      $async:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteExternalService
-                                        
-                                          ({"\n"}
-                                          {"    "}externalService:{" "}
-                                          
-                                            $externalService
-                                          
-                                          ,{"\n"}
-                                          {"    "}async:{" "}
-                                          $async
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "externalService"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "async"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteExternalService"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteFeatureFlag -

-
-
-
-
Description
-

(experimental) Delete a feature flag

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteFeatureFlag
-                                    
-                                      ($name:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteFeatureFlag
-                                        
-                                          (name: $name)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteFeatureFlag"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteFeatureFlagOverride -

-
-
-
-
Description
-

Delete a feature flag override

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the feature flag override to delete
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteFeatureFlagOverride
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteFeatureFlagOverride
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "deleteFeatureFlagOverride"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteOrganization -

-
-
-
-
Description
-

Soft or hard deletes an organization.

-
    -
  • - When the second argument is not provided, it soft deletes - an organization, marking it as deleted. Only site admins - may perform this mutation. -
    • -
  • - When the second argument is true, it hard deletes an - organization and its associated resources. Hard deletion - is currently only supported on cloud. Only org members may - perform this mutation -
    • -
-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - -
- - hard - {" "} - -{" "} - - - Boolean - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $organization: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $hard:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}organization:{" "}
-                                          $organization,
-                                          {"\n"}
-                                          {"    "}hard:{" "}
-                                          $hard
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  ,{" "}
-                                  "hard"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteOrganization"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteRepoKeyValuePair -

-
-
-
-
Description
-

Delete a key-value pair associated with a repo.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - repo - {" "} - -{" "} - - - ID! - - -
- - key - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteRepoKeyValuePair
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $repo: ID!,{"\n"}
-                                      {"  "}
-                                      $key:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteRepoKeyValuePair
-                                        
-                                          ({"\n"}
-                                          {"    "}repo:{" "}
-                                          $repo,{"\n"}
-                                          {"    "}key:{" "}
-                                          $key
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "repo"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "key"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "deleteRepoKeyValuePair"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteRepositoryFromDisk -

-
-
-
-
Description
-

- INTERNAL ONLY: Delete a repository from the gitserver. This - involves deleting the file on disk, and marking it as - not-cloned in the database. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - repo - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteRepositoryFromDisk
-                                    
-                                      ($repo: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteRepositoryFromDisk
-                                        
-                                          (repo: $repo)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "repo"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "deleteRepositoryFromDisk"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteSavedSearch -

-
-
-
-
Description
-

Deletes a saved search

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteSavedSearch
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteSavedSearch
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteSavedSearch"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteTeam -

-
-
-
-
Description
-

- Delete team deletes a team. ID or Name must be specified, - but not both. Must be team-member to delete. If the team is - marked as read-only, must be site-admin. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID - - -
- - name - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteTeam
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID,{"\n"}
-                                      {"  "}
-                                      $name:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteTeam
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}name:{" "}
-                                          $name
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteTeam"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteUser -

-
-
-
-
Description
-

- Deletes a user account. Only site admins may perform this - mutation. -

-

- If hard == true, a hard delete is performed. By default, - deletes are 'soft deletes' and could theoretically be undone - with manual DB commands. If a hard delete is performed, the - data is truly removed from the database and deletion can - NEVER be undone. -

-

Data that is deleted as part of this operation:

-
    -
  • - All user data (access tokens, email addresses, external - account info, survey responses, etc) -
    • -
  • - Organization membership information (which organizations - the user is a part of, any invitations created by or - targeting the user). -
    • -
  • Sourcegraph extensions published by the user.
    • -
  • - User, Organization, or Global settings authored by the - user. -
    • -
-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - hard - {" "} - -{" "} - - - Boolean - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteUser
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $hard:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteUser
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}hard:{" "}
-                                          $hard
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "hard"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteUser"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteUsers -

-
-
-
-
Description
-

Bulk "deleteUser" action.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - users - {" "} - -{" "} - - - [ID!]! - - -
- - hard - {" "} - -{" "} - - - Boolean - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteUsers
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $users: [ID!]!,
-                                      {"\n"}
-                                      {"  "}
-                                      $hard:
-                                       Boolean{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteUsers
-                                        
-                                          ({"\n"}
-                                          {"    "}users:{" "}
-                                          $users,{"\n"}
-                                          {"    "}hard:{" "}
-                                          $hard
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "users"
-                                  :{" "}
-                                  [
-                                  4
-                                  ]
-                                  ,{" "}
-                                  "hard"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteUsers"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- deleteWebhook -

-
-
-
-
Description
-

- Deletes a webhook by given ID. Only site admins may perform - this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    deleteWebhook
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        deleteWebhook
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "deleteWebhook"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- editTemporarySettings -

-
-
-
-
Description
-

- Merges the given settings edit with the current temporary - settings for the current user. Keys in the given edit take - priority over key in the temporary settings. The merge is - not recursive. If temporary settings for the user do not - exist, they are created. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - settingsToEdit - {" "} - -{" "} - - - String! - - - - {" "} - The settings to merge with the current temporary - settings for the current user, as a JSON string.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    editTemporarySettings
-                                    
-                                      ($settingsToEdit:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        editTemporarySettings
-                                        
-                                          (settingsToEdit:{" "}
-                                          $settingsToEdit
-                                          )
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "settingsToEdit"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "editTemporarySettings"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- excludeRepoFromExternalServices -

-
-
-
-
Description
-

- Excludes a repo from external services configs. Only site - admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - externalServices - {" "} - -{" "} - - - [ID!]! - - -
- - repo - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    excludeRepoFromExternalServices
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $externalServices:
-                                      [ID!]!,{"\n"}
-                                      {"  "}
-                                      $repo: ID!{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        excludeRepoFromExternalServices
-                                        
-                                          ({"\n"}
-                                          {"    "}externalServices:{" "}
-                                          
-                                            $externalServices
-                                          
-                                          ,{"\n"}
-                                          {"    "}repo:{" "}
-                                          $repo
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "externalServices"
-                                  :{" "}
-                                  [
-                                  "4"
-                                  ]
-                                  ,{" "}
-                                  "repo"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "excludeRepoFromExternalServices"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- invalidateSessionsByID -

-
-
-
-
Description
-

Invalidates all sessions belonging to a user.

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - userID - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    invalidateSessionsByID
-                                    
-                                      ($userID: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        invalidateSessionsByID
-                                        
-                                          (userID:{" "}
-                                          $userID)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "userID"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "invalidateSessionsByID"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- invalidateSessionsByIDs -

-
-
-
-
Description
-

Bulk "invalidateSessionsByID" action.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - userIDs - {" "} - -{" "} - - - [ID!]! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    invalidateSessionsByIDs
-                                    
-                                      ($userIDs: [ID!]!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        invalidateSessionsByIDs
-                                        
-                                          (userIDs:{" "}
-                                          $userIDs)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "userIDs"
-                                  :{" "}
-                                  [
-                                  "4"
-                                  ]
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "invalidateSessionsByIDs"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- inviteEmailToSourcegraph -

-
-
-
-
Description
-

- Sends an invitation to join Sourcegraph to the given email - address. -

-

- Returns instantly regardless of whether or not an invitation - email was actually sent. For example, the email may fail to - send if there is a typo or it is invalid, or Sourcegraph may - refuse to send it due to spam concerns or if the user has - been invited too recently. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - email - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    inviteEmailToSourcegraph
-                                    
-                                      ($email:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        inviteEmailToSourcegraph
-                                        
-                                          (email: $email)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "inviteEmailToSourcegraph"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- inviteUserToOrganization -

-
-
-
-
Description
-

- Invite the user with the given username to join the - organization. The invited user account must already exist. -

-

- Only site admins and any organization member may perform - this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - InviteUserToOrganizationResult! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - organization - {" "} - -{" "} - - - ID! - - -
- - username - {" "} - -{" "} - - - String - - -
- - email - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    inviteUserToOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $organization: ID!,
-                                      {"\n"}
-                                      {"  "}
-                                      $username:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $email:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        inviteUserToOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}organization:{" "}
-                                          $organization,
-                                          {"\n"}
-                                          {"    "}username:{" "}
-                                          $username,
-                                          {"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            sentInvitationEmail
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          invitationURL
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "inviteUserToOrganization"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "sentInvitationEmail"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "invitationURL"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- logEvent -

-
-
-
-
Description
-

Logs an event.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - event - {" "} - -{" "} - - - String! - - - The name of the event.
- - userCookieID - {" "} - -{" "} - - - String! - - - - {" "} - The randomly generated unique user ID stored in a - browser cookie.{" "} -
- - firstSourceURL - {" "} - -{" "} - - - String - - - - {" "} - The first sourcegraph URL visited by the user, stored - in a browser cookie.{" "} -
- - lastSourceURL - {" "} - -{" "} - - - String - - - - {" "} - The last sourcegraph URL visited by the user, stored - in a browser cookie.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL when the event was logged.
- - source - {" "} - -{" "} - - - EventSource! - - - The source of the event.
- - cohortID - {" "} - -{" "} - - - String - - - - {" "} - An optional cohort ID to identify the user as part of - a specific A/B test. The cohort ID is expected to be a - date in the form YYYY-MM-DD{" "} -
- - referrer - {" "} - -{" "} - - - String - - - - {" "} - An optional referrer parameter for the user's current - session. Only captured and stored on Sourcegraph - Cloud.{" "} -
- - originalReferrer - {" "} - -{" "} - - - String - - - The original referrer for a user
- - sessionReferrer - {" "} - -{" "} - - - String - - - The session referrer for a user
- - sessionFirstURL - {" "} - -{" "} - - - String - - - The sessions first url for a user
- - deviceSessionID - {" "} - -{" "} - - - String - - - - {" "} - Device session ID to identify the user's session for - analytics.{" "} -
- - argument - {" "} - -{" "} - - - String - - - The additional argument information.
- - publicArgument - {" "} - -{" "} - - - String - - - - {" "} - Public argument information. PRIVACY: Do NOT include - any potentially private information in this field. - These properties get sent to our analytics tools for - Cloud, so must not include private information, such - as search queries or repository names.{" "} -
- - deviceID - {" "} - -{" "} - - - String - - - - {" "} - Device ID used for Amplitude analytics. Used on - Sourcegraph Cloud only.{" "} -
- - eventID - {" "} - -{" "} - - - Int - - - - {" "} - Event ID used to deduplicate events that occur - simultaneously in Amplitude analytics. See{" "} - - https://developers.amplitude.com/docs/http-api-v2#optional-keys - - . Used on Sourcegraph Cloud only.{" "} -
- - insertID - {" "} - -{" "} - - - String - - - - {" "} - Insert ID used to deduplicate events that re-occur in - the event of retries or backfills in Amplitude - analytics. See{" "} - - https://developers.amplitude.com/docs/http-api-v2#optional-keys - - . Used on Sourcegraph Cloud only.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation logEvent
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $event:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $userCookieID:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $firstSourceURL:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $lastSourceURL:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $url:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $source:
-                                       EventSource!,
-                                      {"\n"}
-                                      {"  "}
-                                      $cohortID:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $referrer:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $originalReferrer:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $sessionReferrer:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $sessionFirstURL:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $deviceSessionID:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $argument:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $publicArgument:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $deviceID:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $eventID:
-                                       Int,
-                                      {"\n"}
-                                      {"  "}
-                                      $insertID:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        logEvent
-                                        
-                                          ({"\n"}
-                                          {"    "}event:{" "}
-                                          $event,{"\n"}
-                                          {"    "}userCookieID:{" "}
-                                          $userCookieID,
-                                          {"\n"}
-                                          {"    "}firstSourceURL:{" "}
-                                          $firstSourceURL
-                                          ,{"\n"}
-                                          {"    "}lastSourceURL:{" "}
-                                          $lastSourceURL,
-                                          {"\n"}
-                                          {"    "}url:{" "}
-                                          $url,{"\n"}
-                                          {"    "}source:{" "}
-                                          $source,{"\n"}
-                                          {"    "}cohortID:{" "}
-                                          $cohortID,
-                                          {"\n"}
-                                          {"    "}referrer:{" "}
-                                          $referrer,
-                                          {"\n"}
-                                          {"    "}originalReferrer:{" "}
-                                          
-                                            $originalReferrer
-                                          
-                                          ,{"\n"}
-                                          {"    "}sessionReferrer:{" "}
-                                          
-                                            $sessionReferrer
-                                          
-                                          ,{"\n"}
-                                          {"    "}sessionFirstURL:{" "}
-                                          
-                                            $sessionFirstURL
-                                          
-                                          ,{"\n"}
-                                          {"    "}deviceSessionID:{" "}
-                                          
-                                            $deviceSessionID
-                                          
-                                          ,{"\n"}
-                                          {"    "}argument:{" "}
-                                          $argument,
-                                          {"\n"}
-                                          {"    "}publicArgument:{" "}
-                                          $publicArgument
-                                          ,{"\n"}
-                                          {"    "}deviceID:{" "}
-                                          $deviceID,
-                                          {"\n"}
-                                          {"    "}eventID:{" "}
-                                          $eventID,{"\n"}
-                                          {"    "}insertID:{" "}
-                                          $insertID
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "event"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "userCookieID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "firstSourceURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastSourceURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "source"
-                                  :{" "}
-                                  "WEB"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cohortID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "referrer"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "originalReferrer"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "sessionReferrer"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "sessionFirstURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "deviceSessionID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "argument"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "publicArgument"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "deviceID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "eventID"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "insertID"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "logEvent"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- logEvents -

-
-
-
-
Description
-

Logs a batch of events.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - events - {" "} - -{" "} - - - [Event!] - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation logEvents
-                                    
-                                      ($events:{" "}
-                                      [Event!])
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        logEvents
-                                        
-                                          (events:{" "}
-                                          $events)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "events"
-                                  :{" "}
-                                  [
-                                  Event
-                                  ]
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "logEvents"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- logUserEvent -

-
-
-
-
- {" "} - use logEvent instead{" "} -
-
-
-
-
-
-
-
Description
-

- Logs a user event. No longer used, only here for backwards - compatibility with IDE and browser extensions. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - event - {" "} - -{" "} - - - UserEvent! - - -
- - userCookieID - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    logUserEvent
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $event:
-                                       UserEvent!,{"\n"}
-                                      {"  "}
-                                      $userCookieID:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        logUserEvent
-                                        
-                                          ({"\n"}
-                                          {"    "}event:{" "}
-                                          $event,{"\n"}
-                                          {"    "}userCookieID:{" "}
-                                          $userCookieID
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "event"
-                                  :{" "}
-                                  "PAGEVIEW"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "userCookieID"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "logUserEvent"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- overwriteTemporarySettings -

-
-
-
-
Description
-

- Overwrites and saves the temporary settings for the current - user. If temporary settings for the user do not exist, they - are created. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - contents - {" "} - -{" "} - - - String! - - - - {" "} - The new temporary settings for the current user, as a - JSON string.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    overwriteTemporarySettings
-                                    
-                                      ($contents:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        overwriteTemporarySettings
-                                        
-                                          (contents:{" "}
-                                          $contents)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "contents"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "overwriteTemporarySettings"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- randomizeUserPassword -

-
-
-
-
Description
-

- Randomize a user's password so that they need to reset it - before they can sign in again. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - RandomizeUserPasswordResult! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    randomizeUserPassword
-                                    
-                                      ($user: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        randomizeUserPassword
-                                        
-                                          (user: $user)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            resetPasswordURL
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          emailSent
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "randomizeUserPassword"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "resetPasswordURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "emailSent"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- recloneRepository -

-
-
-
-
Description
-

- INTERNAL ONLY: Reclone a repository from the gitserver. This - involves deleting the file on disk, marking it as not-cloned - in the database, and then initiating a repo clone. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - repo - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    recloneRepository
-                                    
-                                      ($repo: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        recloneRepository
-                                        
-                                          (repo: $repo)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "repo"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "recloneRepository"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- recoverUsers -

-
-
-
-
Description
-

Bulk "recoverUser" action.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - userIDs - {" "} - -{" "} - - - [ID!]! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    recoverUsers
-                                    
-                                      ($userIDs: [ID!]!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        recoverUsers
-                                        
-                                          (userIDs:{" "}
-                                          $userIDs)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "userIDs"
-                                  :{" "}
-                                  [
-                                  "4"
-                                  ]
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "recoverUsers"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- reindexRepository -

-
-
-
-
Description
-

- Force Zoekt to reindex the repository right now. Reindexing - occurs automatically, so this should not normally be needed. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - repository - {" "} - -{" "} - - - ID! - - - The repository to index
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    reindexRepository
-                                    
-                                      ($repository: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        reindexRepository
-                                        
-                                          (repository:{" "}
-                                          $repository)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "repository"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "reindexRepository"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- reloadSite -

-
-
-
-
Description
-

- Reloads the site by restarting the server. This is not - supported for all deployment types. This may cause downtime. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    reloadSite{" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        reloadSite{" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "reloadSite"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- removeTeamMembers -

-
-
-
-
Description
-

- This mutation removes team membership for the given team and - set of members. Members that weren't part of the team are - ignored. -

-

- Either team XOR teamName can be specified to specify the - team. Must be team member to remove team members, or - site-admin. -

-

- For now, members can only be the IDs of User entities in - Sourcegraph. Later, we will expand this to allow Persons as - well. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - team - {" "} - -{" "} - - - ID - - -
- - teamName - {" "} - -{" "} - - - String - - -
- - members - {" "} - -{" "} - - - [ID!]! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    removeTeamMembers
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $team: ID,{"\n"}
-                                      {"  "}
-                                      $teamName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $members: [ID!]!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        removeTeamMembers
-                                        
-                                          ({"\n"}
-                                          {"    "}team:{" "}
-                                          $team,{"\n"}
-                                          {"    "}teamName:{" "}
-                                          $teamName,
-                                          {"\n"}
-                                          {"    "}members:{" "}
-                                          $members
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "team"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "teamName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "members"
-                                  :{" "}
-                                  [
-                                  4
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "removeTeamMembers"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- removeUserEmail -

-
-
-
-
Description
-

Removes an email address from the user's account.

-

- Only the user and site admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - email - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    removeUserEmail
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        removeUserEmail
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "removeUserEmail"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- removeUserFromOrganization -

-
-
-
-
Description
-

Removes a user as a member from an organization.

-

- Only site admins and any member of the organization may - perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - organization - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    removeUserFromOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $organization: ID!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        removeUserFromOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}organization:{" "}
-                                          $organization
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "organization"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "removeUserFromOrganization"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- resendOrganizationInvitationNotification -

-
-
-
-
Description
-

- Resend the notification about an organization invitation to - the recipient. -

-

- Only site admins and any member of the organization may - perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - organizationInvitation - {" "} - -{" "} - - - ID! - - - The organization invitation.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    resendOrganizationInvitationNotification
-                                    
-                                      (
-                                      
-                                        $organizationInvitation
-                                      
-                                      : ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        resendOrganizationInvitationNotification
-                                        
-                                          (organizationInvitation:{" "}
-                                          
-                                            $organizationInvitation
-                                          
-                                          )
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  
-                                    "organizationInvitation"
-                                  
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "resendOrganizationInvitationNotification"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- resendVerificationEmail -

-
-
-
-
Description
-

- Resend a verification email, no op if the email is already - verified. -

-

- Only the user and site admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - email - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    resendVerificationEmail
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        resendVerificationEmail
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "resendVerificationEmail"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- resolvePhabricatorDiff -

-
-
-
-
Description
-

Resolves a revision for a given diff from Phabricator.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - GitCommit - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - repoName - {" "} - -{" "} - - - String! - - - - {" "} - The name of the repository that the diff is based on.{" "} -
- - diffID - {" "} - -{" "} - - - ID! - - - The ID of the diff on Phabricator.
- - baseRev - {" "} - -{" "} - - - String! - - - The base revision this diff is based on.
- - patch - {" "} - -{" "} - - - String - - - - {" "} - The raw contents of the diff from Phabricator. - Required if Sourcegraph doesn't have a Conduit API - token.{" "} -
- - description - {" "} - -{" "} - - - String - - - - {" "} - The description of the diff. This will be used as the - commit message.{" "} -
- - authorName - {" "} - -{" "} - - - String - - - The name of author of the diff.
- - authorEmail - {" "} - -{" "} - - - String - - - The author's email.
- - date - {" "} - -{" "} - - - String - - - When the diff was created.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    resolvePhabricatorDiff
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $repoName:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $diffID: ID!,{"\n"}
-                                      {"  "}
-                                      $baseRev:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $patch:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $description:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $authorName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $authorEmail:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $date:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        resolvePhabricatorDiff
-                                        
-                                          ({"\n"}
-                                          {"    "}repoName:{" "}
-                                          $repoName,
-                                          {"\n"}
-                                          {"    "}diffID:{" "}
-                                          $diffID,{"\n"}
-                                          {"    "}baseRev:{" "}
-                                          $baseRev,{"\n"}
-                                          {"    "}patch:{" "}
-                                          $patch,{"\n"}
-                                          {"    "}description:{" "}
-                                          $description,
-                                          {"\n"}
-                                          {"    "}authorName:{" "}
-                                          $authorName,
-                                          {"\n"}
-                                          {"    "}authorEmail:{" "}
-                                          $authorEmail,
-                                          {"\n"}
-                                          {"    "}date:{" "}
-                                          $date
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            repository{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...RepositoryFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          oid
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            abbreviatedOID
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            author{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SignatureFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            committer{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SignatureFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          message
-                                          {"\n"}
-                                          {"    "}
-                                          subject
-                                          {"\n"}
-                                          {"    "}
-                                          body
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parents{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...GitCommitFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          canonicalURL
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalURLs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalLinkFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            path{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on GitTree{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...GitTreeFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on GitBlob{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...GitBlobFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                tree{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...GitTreeFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              fileNames
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                blob{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...GitBlobFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                file{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...File2Fragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              languages
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                languageStatistics{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...LanguageStatisticsFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                ancestors{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...GitCommitConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                behindAhead{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...BehindAheadCountsFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                symbols{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...SymbolConnectionFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                diff{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"      "}
-                                                  
-                                                    ...RepositoryComparisonFragment
-                                                  
-                                                  {"\n"}
-                                                  {"    "}
-                                                  {"}"}
-                                                
-                                              
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "repoName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "diffID"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "baseRev"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "patch"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "description"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "authorName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "authorEmail"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "date"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "resolvePhabricatorDiff"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "oid"
-                                  :{" "}
-                                  GitObjectID
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "abbreviatedOID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "author"
-                                  :{" "}
-                                  Signature
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "committer"
-                                  :{" "}
-                                  Signature
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "message"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "subject"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "body"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parents"
-                                  :{" "}
-                                  [
-                                  GitCommit
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "canonicalURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalURLs"
-                                  :{" "}
-                                  [
-                                  ExternalLink
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "path"
-                                  :{" "}
-                                  GitTree
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tree"
-                                  :{" "}
-                                  GitTree
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "fileNames"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "blob"
-                                  :{" "}
-                                  GitBlob
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "file"
-                                  :{" "}
-                                  File2
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "languages"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "languageStatistics"
-                                  :{" "}
-                                  [
-                                  LanguageStatistics
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "ancestors"
-                                  :{" "}
-                                  GitCommitConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "behindAhead"
-                                  :{" "}
-                                  BehindAheadCounts
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "symbols"
-                                  :{" "}
-                                  SymbolConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "diff"
-                                  :{" "}
-                                  RepositoryComparison
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- respondToOrganizationInvitation -

-
-
-
-
Description
-

Accept or reject an existing organization invitation.

-

- Only the recipient of the invitation may perform this - mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - organizationInvitation - {" "} - -{" "} - - - ID! - - - The organization invitation.
- - responseType - {" "} - -{" "} - - - OrganizationInvitationResponseType! - - - The response to the invitation.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    respondToOrganizationInvitation
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      
-                                        $organizationInvitation
-                                      
-                                      : ID!,{"\n"}
-                                      {"  "}
-                                      $responseType:
-                                      
-                                        {" "}
-                                        OrganizationInvitationResponseType!
-                                      
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        respondToOrganizationInvitation
-                                        
-                                          ({"\n"}
-                                          {"    "}organizationInvitation:{" "}
-                                          
-                                            $organizationInvitation
-                                          
-                                          ,{"\n"}
-                                          {"    "}responseType:{" "}
-                                          $responseType
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  
-                                    "organizationInvitation"
-                                  
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "responseType"
-                                  :{" "}
-                                  "ACCEPT"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "respondToOrganizationInvitation"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- revokeOrganizationInvitation -

-
-
-
-
Description
-

Revoke an existing organization invitation.

-

- If the invitation has been accepted or rejected, it may no - longer be revoked. After an invitation is revoked, the - recipient may not accept or reject it. Both cases yield an - error. -

-

- Only site admins and any member of the organization may - perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - organizationInvitation - {" "} - -{" "} - - - ID! - - - The organization invitation.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    revokeOrganizationInvitation
-                                    
-                                      (
-                                      
-                                        $organizationInvitation
-                                      
-                                      : ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        revokeOrganizationInvitation
-                                        
-                                          (organizationInvitation:{" "}
-                                          
-                                            $organizationInvitation
-                                          
-                                          )
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  
-                                    "organizationInvitation"
-                                  
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "revokeOrganizationInvitation"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- sendTestEmail -

-
-
-
-
Description
-

- Sends an email for testing Sourcegraph's email - configuration. -

-

Only administrators can use this API.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - String! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - to - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    sendTestEmail
-                                    
-                                      ($to:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        sendTestEmail
-                                        
-                                          (to: $to)
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "to"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "sendTestEmail"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setMigrationDirection -

-
-
-
-
Description
-

- Updates an out-of-band migration to run in a particular - direction. -

-

- Applied in the forward direction, an out-of-band migration - migrates data into a format that is readable by newer - Sourcegraph instances. This may be destructive or - non-destructive process, depending on the nature and - implementation of the migration. -

-

- Applied in the reverse direction, an out-of-band migration - ensures that data is moved back into a format that is - readable by the previous Sourcegraph instance. Recently - introduced migrations should be applied in reverse prior to - downgrading the instance. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
- - applyReverse - {" "} - -{" "} - - - Boolean! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setMigrationDirection
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $applyReverse:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setMigrationDirection
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}applyReverse:{" "}
-                                          $applyReverse
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,{" "}
-                                  "applyReverse"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setMigrationDirection"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setSearchable -

-
-
-
-
Description
-

- Current user opt in/out from being searchable in the users - picker. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - searchable - {" "} - -{" "} - - - Boolean! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setSearchable
-                                    
-                                      ($searchable:
-                                       Boolean!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setSearchable
-                                        
-                                          (searchable:{" "}
-                                          $searchable)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "searchable"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setSearchable"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setTag -

-
-
-
-
Description
-

Adds or removes a tag on a user.

-

- Tags are used internally by Sourcegraph as feature flags for - experimental features. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - node - {" "} - -{" "} - - - ID! - - - -

The ID of the user whose tags to set.

-

- (This parameter is named "node" to make it easy to - support tagging other types of nodes other than - users in the future.) -

-
- - tag - {" "} - -{" "} - - - String! - - - The tag to set.
- - present - {" "} - -{" "} - - - Boolean! - - - - {" "} - The desired state of the tag on the user (whether to - add or remove): true to add, false to remove.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation setTag
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $node: ID!,{"\n"}
-                                      {"  "}
-                                      $tag:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $present:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setTag
-                                        
-                                          ({"\n"}
-                                          {"    "}node:{" "}
-                                          $node,{"\n"}
-                                          {"    "}tag:{" "}
-                                          $tag,{"\n"}
-                                          {"    "}present:{" "}
-                                          $present
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "node"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "tag"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "present"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setTag"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setTeamMembers -

-
-
-
-
Description
-

- This is a convenience method to forcefully overwrite the - full set of members of a team. This is handy to sync - external state without diffing the current members vs the - desired set of members. -

-

- Either team XOR teamName can be specified to specify the - team. Must be team member to modify team members, or - site-admin. -

-

- For now, members can only be the IDs of User entities in - Sourcegraph. Later, we will expand this to allow Persons as - well. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - team - {" "} - -{" "} - - - ID - - -
- - teamName - {" "} - -{" "} - - - String - - -
- - members - {" "} - -{" "} - - - [ID!]! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setTeamMembers
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $team: ID,{"\n"}
-                                      {"  "}
-                                      $teamName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $members: [ID!]!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setTeamMembers
-                                        
-                                          ({"\n"}
-                                          {"    "}team:{" "}
-                                          $team,{"\n"}
-                                          {"    "}teamName:{" "}
-                                          $teamName,
-                                          {"\n"}
-                                          {"    "}members:{" "}
-                                          $members
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "team"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "teamName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "members"
-                                  :{" "}
-                                  [
-                                  4
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setTeamMembers"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setTosAccepted -

-
-
-
-
Description
-

- Sets the user to accept the site's Terms of Service and - Privacy Policy. If the ID is omitted, the current user is - assumed. -

-

Only the user or site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - userID - {" "} - -{" "} - - - ID - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setTosAccepted
-                                    
-                                      ($userID: ID)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setTosAccepted
-                                        
-                                          (userID:{" "}
-                                          $userID)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "userID"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setTosAccepted"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setUserEmailPrimary -

-
-
-
-
Description
-

Set an email address as the user's primary.

-

- Only the user and site admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - email - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setUserEmailPrimary
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setUserEmailPrimary
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}email:{" "}
-                                          $email
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "email"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setUserEmailPrimary"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setUserEmailVerified -

-
-
-
-
Description
-

- Manually set the verification status of a user's email, - without going through the normal verification process (of - clicking on a link in the email with a verification code). -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - email - {" "} - -{" "} - - - String! - - -
- - verified - {" "} - -{" "} - - - Boolean! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setUserEmailVerified
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $email:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $verified:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setUserEmailVerified
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}email:{" "}
-                                          $email,{"\n"}
-                                          {"    "}verified:{" "}
-                                          $verified
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "verified"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setUserEmailVerified"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- setUserIsSiteAdmin -

-
-
-
-
Description
-

- Sets whether the user with the specified user ID is a site - admin. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - userID - {" "} - -{" "} - - - ID! - - -
- - siteAdmin - {" "} - -{" "} - - - Boolean! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    setUserIsSiteAdmin
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $userID: ID!,{"\n"}
-                                      {"  "}
-                                      $siteAdmin:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        setUserIsSiteAdmin
-                                        
-                                          ({"\n"}
-                                          {"    "}userID:{" "}
-                                          $userID,{"\n"}
-                                          {"    "}siteAdmin:{" "}
-                                          $siteAdmin
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "userID"
-                                  :{" "}
-                                  "4"
-                                  ,{" "}
-                                  "siteAdmin"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "setUserIsSiteAdmin"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- settingsMutation -

-
-
-
-
Description
-

- All mutations that update settings (global, organization, - and user settings) are under this field. -

-

- Only the settings subject whose settings are being mutated - (and site admins) may perform this mutation. -

-

- This mutation only affects global, organization, and user - settings, not site configuration. For site configuration - (which is a separate set of configuration properties from - global/organization/user settings), use - updateSiteConfiguration. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SettingsMutation - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - SettingsMutationGroupInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    settingsMutation
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        SettingsMutationGroupInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        settingsMutation
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            editSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            editConfiguration{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            overwriteSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UpdateSettingsPayloadFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  
-                                    SettingsMutationGroupInput
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "settingsMutation"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "editSettings"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "editConfiguration"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "overwriteSettings"
-                                  :{" "}
-                                  UpdateSettingsPayload
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- submitHappinessFeedback -

-
-
-
-
Description
-

Submits happiness feedback.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - HappinessFeedbackSubmissionInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    submitHappinessFeedback
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        HappinessFeedbackSubmissionInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        submitHappinessFeedback
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  
-                                    HappinessFeedbackSubmissionInput
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "submitHappinessFeedback"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- submitSurvey -

-
-
-
-
Description
-

Submits a user satisfaction (NPS) survey.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - SurveySubmissionInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    submitSurvey
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        SurveySubmissionInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        submitSurvey
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  SurveySubmissionInput
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "submitSurvey"
-                                  :{" "}
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- syncExternalService -

-
-
-
-
Description
-

- Enqueues a sync for the external service. It will be picked - up in the background. -

-

Site-admin or owner of the external service only.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    syncExternalService
-                                    
-                                      ($id: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        syncExternalService
-                                        
-                                          (id: $id)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "syncExternalService"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- triggerObservabilityTestAlert -

-
-
-
-
Description
-

OBSERVABILITY

-

- Set the status of a test alert of the specified parameters - - useful for validating 'observability.alerts' configuration. - Alerts may take up to a minute to fire. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - level - {" "} - -{" "} - - - String! - - - - {" "} - Level of alert to test - either warning or critical.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    triggerObservabilityTestAlert
-                                    
-                                      ($level:
-                                       String!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        triggerObservabilityTestAlert
-                                        
-                                          (level: $level)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "level"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "triggerObservabilityTestAlert"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateExecutorSecret -

-
-
-
-
Description
-

Update the value of an existing executor secret.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExecutorSecret! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - - The scope of the secret.
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - The identifier of the secret that shall be updated.{" "} -
- - value - {" "} - -{" "} - - - String! - - - The new secret value.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateExecutorSecret
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $scope:
-                                      
-                                        {" "}
-                                        ExecutorSecretScope!
-                                      
-                                      ,{"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateExecutorSecret
-                                        
-                                          ({"\n"}
-                                          {"    "}scope:{" "}
-                                          $scope,{"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          key
-                                          {"\n"}
-                                          {"    "}
-                                          scope
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            overwritesGlobalSecret
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            creator{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretAccessLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateExecutorSecret"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "key"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "overwritesGlobalSecret"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "creator"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessLogs"
-                                  :{" "}
-                                  
-                                    ExecutorSecretAccessLogConnection
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateExternalService -

-
-
-
-
Description
-

- Updates a external service. Only site admins may perform - this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - ExternalService! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - input - {" "} - -{" "} - - - UpdateExternalServiceInput! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateExternalService
-                                    
-                                      ($input:
-                                      
-                                        {" "}
-                                        UpdateExternalServiceInput!
-                                      
-                                      )
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateExternalService
-                                        
-                                          (input: $input)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          kind
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          config
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          repoCount
-                                          {"\n"}
-                                          {"    "}
-                                          webhookURL
-                                          {"\n"}
-                                          {"    "}
-                                          warning
-                                          {"\n"}
-                                          {"    "}
-                                          lastSyncError
-                                          {"\n"}
-                                          {"    "}
-                                          lastSyncAt
-                                          {"\n"}
-                                          {"    "}
-                                          nextSyncAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            webhookLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            syncJobs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalServiceSyncJobConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            checkConnection{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on ExternalServiceAvailable{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceAvailableFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on ExternalServiceUnavailable{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceUnavailableFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on
-                                                ExternalServiceAvailabilityUnknown{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...ExternalServiceAvailabilityUnknownFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                hasConnectionCheck
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              
-                                                supportsRepoExclusion
-                                              
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "input"
-                                  :{" "}
-                                  
-                                    UpdateExternalServiceInput
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateExternalService"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "config"
-                                  :{" "}
-                                  JSONCString
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "repoCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "warning"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "lastSyncError"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "lastSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "nextSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "syncJobs"
-                                  :{" "}
-                                  
-                                    ExternalServiceSyncJobConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "checkConnection"
-                                  :{" "}
-                                  
-                                    ExternalServiceAvailable
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "hasConnectionCheck"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "supportsRepoExclusion"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateFeatureFlag -

-
-
-
-
Description
-

(experimental) Update a feature flag

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - FeatureFlag! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
- - value - {" "} - -{" "} - - - Boolean - - - - {" "} - The value of the feature flag. Only set if the new - feature flag will be a concrete boolean flag. Mutually - exclusive with rollout.{" "} -
- - rolloutBasisPoints - {" "} - -{" "} - - - Int - - - - {" "} - The ratio of users the feature flag will apply to, - expressed in basis points (0.01%). Mutually exclusive - with value.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateFeatureFlag
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $name:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       Boolean,
-                                      {"\n"}
-                                      {"  "}
-                                      $rolloutBasisPoints
-                                      : Int{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateFeatureFlag
-                                        
-                                          ({"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value,{"\n"}
-                                          {"    "}rolloutBasisPoints:{" "}
-                                          
-                                            $rolloutBasisPoints
-                                          
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"   "}
-                                          
-                                            {" "}
-                                            ... on FeatureFlagBoolean{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagBooleanFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"    "}... on FeatureFlagRollout{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...FeatureFlagRolloutFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                            {"\n"}
-                                            {"  "}
-                                            {"}"}
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "rolloutBasisPoints"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  "updateFeatureFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateFeatureFlagOverride -

-
-
-
-
Description
-

Update a feature flag override

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - FeatureFlagOverride! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the feature flag override to update
- - value - {" "} - -{" "} - - - Boolean! - - - - {" "} - The updated value of the feature flag override{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateFeatureFlagOverride
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       Boolean!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateFeatureFlagOverride
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            targetFlag{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"     "}
-                                              
-                                                {" "}
-                                                ... on FeatureFlagBoolean{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagBooleanFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"      "}... on FeatureFlagRollout{" "}
-                                                
-                                                  {"{"}
-                                                  {"\n"}
-                                                  {"        "}
-                                                  
-                                                    ...FeatureFlagRolloutFragment
-                                                  
-                                                  {"\n"}
-                                                  {"      "}
-                                                  {"}"}
-                                                
-                                                {"\n"}
-                                                {"    "}
-                                                {"}"}
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              value
-                                              {"\n"}
-                                              {"  "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"}"}
-                                        
-                                      
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,{" "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "updateFeatureFlagOverride"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "targetFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateMirrorRepository -

-
-
-
-
Description
-

- Schedule the mirror repository to be updated from its - original source repository. Updating occurs automatically, - so this should not normally be needed. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - -
NameDescription
- - repository - {" "} - -{" "} - - - ID! - - - The mirror repository to update.
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateMirrorRepository
-                                    
-                                      ($repository: ID!)
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateMirrorRepository
-                                        
-                                          (repository:{" "}
-                                          $repository)
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "repository"
-                                  :{" "}
-                                  4
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "updateMirrorRepository"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateOrganization -

-
-
-
-
Description
-

Updates an organization.

-

- Only site admins and any member of the organization may - perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - Org! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
- - displayName - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateOrganization
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $displayName:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateOrganization
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}displayName:{" "}
-                                          $displayName
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NewUsersConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerPendingInvitation{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationInvitationFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerIsMember
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,{" "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateOrganization"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  NewUsersConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerPendingInvitation"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationInvitation
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerIsMember"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updatePassword -

-
-
-
-
Description
-

- Updates the current user's password. The oldPassword arg - must match the user's current password. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - oldPassword - {" "} - -{" "} - - - String! - - -
- - newPassword - {" "} - -{" "} - - - String! - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updatePassword
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $oldPassword:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $newPassword:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updatePassword
-                                        
-                                          ({"\n"}
-                                          {"    "}oldPassword:{" "}
-                                          $oldPassword,
-                                          {"\n"}
-                                          {"    "}newPassword:{" "}
-                                          $newPassword
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "oldPassword"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "newPassword"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updatePassword"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateRepoKeyValuePair -

-
-
-
-
Description
-

Update a key-value pair associated with a repo.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns an{" "} - - EmptyResponse! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - repo - {" "} - -{" "} - - - ID! - - -
- - key - {" "} - -{" "} - - - String! - - -
- - value - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateRepoKeyValuePair
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $repo: ID!,{"\n"}
-                                      {"  "}
-                                      $key:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $value:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateRepoKeyValuePair
-                                        
-                                          ({"\n"}
-                                          {"    "}repo:{" "}
-                                          $repo,{"\n"}
-                                          {"    "}key:{" "}
-                                          $key,{"\n"}
-                                          {"    "}value:{" "}
-                                          $value
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          alwaysNil
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "repo"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "key"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    "updateRepoKeyValuePair"
-                                  
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateSavedSearch -

-
-
-
-
Description
-

Updates a saved search

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - SavedSearch! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
- - description - {" "} - -{" "} - - - String! - - -
- - query - {" "} - -{" "} - - - String! - - -
- - notifyOwner - {" "} - -{" "} - - - Boolean! - - -
- - notifySlack - {" "} - -{" "} - - - Boolean! - - -
- - orgID - {" "} - -{" "} - - - ID - - -
- - userID - {" "} - -{" "} - - - ID - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateSavedSearch
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $description:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $query:
-                                       String!,{"\n"}
-                                      {"  "}
-                                      $notifyOwner:
-                                       Boolean!,{"\n"}
-                                      {"  "}
-                                      $notifySlack:
-                                       Boolean!,{"\n"}
-                                      {"  "}
-                                      $orgID: ID,{"\n"}
-                                      {"  "}
-                                      $userID: ID{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateSavedSearch
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}description:{" "}
-                                          $description,
-                                          {"\n"}
-                                          {"    "}query:{" "}
-                                          $query,{"\n"}
-                                          {"    "}notifyOwner:{" "}
-                                          $notifyOwner,
-                                          {"\n"}
-                                          {"    "}notifySlack:{" "}
-                                          $notifySlack,
-                                          {"\n"}
-                                          {"    "}orgID:{" "}
-                                          $orgID,{"\n"}
-                                          {"    "}userID:{" "}
-                                          $userID
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          description
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            query
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          notify
-                                          {"\n"}
-                                          {"    "}
-                                          notifySlack
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            namespace{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...NamespaceFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            slackWebhookURL
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "description"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "query"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notifyOwner"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notifySlack"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "orgID"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "userID"
-                                  :{" "}
-                                  "4"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateSavedSearch"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "description"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "query"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notify"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "notifySlack"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "slackWebhookURL"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateSiteConfiguration -

-
-
-
-
Description
-

- Updates the site configuration. Returns whether or not a - restart is required for the update to be applied. -

-

Only site admins may perform this mutation.

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Boolean! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - -
NameDescription
- - lastID - {" "} - -{" "} - - - Int! - - - - {" "} - The last ID of the site configuration that is known by - the client, to prevent race conditions. An error will - be returned if someone else has already written a new - update.{" "} -
- - input - {" "} - -{" "} - - - String! - - - - {" "} - A JSON object containing the entire site - configuration. The previous site configuration will be - replaced with this new value.{" "} -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateSiteConfiguration
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $lastID:
-                                       Int!,{"\n"}
-                                      {"  "}
-                                      $input:
-                                       String!
-                                      {"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateSiteConfiguration
-                                        
-                                          ({"\n"}
-                                          {"    "}lastID:{" "}
-                                          $lastID,{"\n"}
-                                          {"    "}input:{" "}
-                                          $input
-                                          {"\n"}
-                                          {"  "})
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  "lastID"
-                                  :{" "}
-                                  123
-                                  ,{" "}
-                                  "input"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  
-                                    "updateSiteConfiguration"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateTeam -

-
-
-
-
Description
-

- Update an existing team. ID or Name must be specified, but - not both. -

-

- To unset the display name, pass an empty string. Null will - make it ignore updates. -

-

- Either parentTeam XOR parentTeamName can be specified to - make the team a child team of the given parent. The user has - to be a team-member of both the child and parent team for - that, and neither can be read-only. Site-admin can modify - all teams without constraints. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Team! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID - - -
- - name - {" "} - -{" "} - - - String - - -
- - displayName - {" "} - -{" "} - - - String - - -
- - parentTeam - {" "} - -{" "} - - - ID - - -
- - parentTeamName - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateTeam
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID,{"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $displayName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $parentTeam: ID,
-                                      {"\n"}
-                                      {"  "}
-                                      $parentTeamName:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateTeam
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}displayName:{" "}
-                                          $displayName,
-                                          {"\n"}
-                                          {"    "}parentTeam:{" "}
-                                          $parentTeam,
-                                          {"\n"}
-                                          {"    "}parentTeamName:{" "}
-                                          $parentTeamName
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          readonly
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            members{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamMemberConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            parentTeam{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            childTeams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parentTeam"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parentTeamName"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateTeam"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "readonly"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "members"
-                                  :{" "}
-                                  TeamMemberConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "parentTeam"
-                                  :{" "}
-                                  Team
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "childTeams"
-                                  :{" "}
-                                  TeamConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateUser -

-
-
-
-
Description
-

- Updates the user profile information for the user with the - given ID. -

-

- Only the user and site admins may perform this mutation. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - User! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - user - {" "} - -{" "} - - - ID! - - -
- - username - {" "} - -{" "} - - - String - - -
- - displayName - {" "} - -{" "} - - - String - - -
- - avatarURL - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateUser
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $user: ID!,{"\n"}
-                                      {"  "}
-                                      $username:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $displayName:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $avatarURL:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateUser
-                                        
-                                          ({"\n"}
-                                          {"    "}user:{" "}
-                                          $user,{"\n"}
-                                          {"    "}username:{" "}
-                                          $username,
-                                          {"\n"}
-                                          {"    "}displayName:{" "}
-                                          $displayName,
-                                          {"\n"}
-                                          {"    "}avatarURL:{" "}
-                                          $avatarURL
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            executorSecrets{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExecutorSecretConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          username
-                                          {"\n"}
-                                          {"    "}
-                                          email
-                                          {"\n"}
-                                          {"    "}
-                                          displayName
-                                          {"\n"}
-                                          {"    "}
-                                          avatarURL
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          settingsURL
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          siteAdmin
-                                          {"\n"}
-                                          {"    "}
-                                          builtinAuth
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            latestSettings{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            settingsCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SettingsCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            configurationCascade{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ConfigurationCascadeFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizations{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrgConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            organizationMemberships{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...OrganizationMembershipConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          tags
-                                          {"\n"}
-                                          {"    "}
-                                          tosAccepted
-                                          {"\n"}
-                                          {"    "}
-                                          searchable
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            usageStatistics{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserUsageStatisticsFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            eventLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...EventLogsConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            emails{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserEmailFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            accessTokens{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...AccessTokenConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            externalAccounts{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...ExternalAccountConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            session{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SessionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanAdminister
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            viewerCanChangeUsername
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            surveyResponses{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...SurveyResponseFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          databaseID
-                                          {"\n"}
-                                          {"    "}
-                                          namespaceName
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            invitableCollaborators{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...PersonFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            teams{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...TeamConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateUser"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "executorSecrets"
-                                  :{" "}
-                                  
-                                    ExecutorSecretConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "email"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "siteAdmin"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "builtinAuth"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "organizations"
-                                  :{" "}
-                                  OrgConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "organizationMemberships"
-                                  
-                                  :{" "}
-                                  
-                                    OrganizationMembershipConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tags"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "tosAccepted"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "searchable"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "usageStatistics"
-                                  :{" "}
-                                  UserUsageStatistics
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "eventLogs"
-                                  :{" "}
-                                  EventLogsConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "emails"
-                                  :{" "}
-                                  [
-                                  UserEmail
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "accessTokens"
-                                  :{" "}
-                                  AccessTokenConnection
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "externalAccounts"
-                                  :{" "}
-                                  
-                                    ExternalAccountConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "session"
-                                  :{" "}
-                                  Session
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "viewerCanChangeUsername"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "surveyResponses"
-                                  :{" "}
-                                  [
-                                  SurveyResponse
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "databaseID"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "namespaceName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  
-                                    "invitableCollaborators"
-                                  
-                                  :{" "}
-                                  [
-                                  Person
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "teams"
-                                  :{" "}
-                                  TeamConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Mutations -
-

- updateWebhook -

-
-
-
-
Description
-

- Updates a webhook with given ID. Null values aren't updated. -

-
-
-
-
-
-
-
Response
-

- {" "} - Returns a{" "} - - Webhook! - -

-
-
-
Arguments
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
- - id - {" "} - -{" "} - - - ID! - - -
- - name - {" "} - -{" "} - - - String - - -
- - codeHostKind - {" "} - -{" "} - - - String - - -
- - codeHostURN - {" "} - -{" "} - - - String - - -
- - secret - {" "} - -{" "} - - - String - - -
-
-
-
-

Example

-
-
Query
- 
-                                
-                                  
-                                    mutation{" "}
-                                    updateWebhook
-                                    
-                                      ({"\n"}
-                                      {"  "}
-                                      $id: ID!,{"\n"}
-                                      {"  "}
-                                      $name:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $codeHostKind:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $codeHostURN:
-                                       String,
-                                      {"\n"}
-                                      {"  "}
-                                      $secret:
-                                       String{"\n"})
-                                    {" "}
-                                    
-                                      {"{"}
-                                      {"\n"}
-                                      {"  "}
-                                      
-                                        updateWebhook
-                                        
-                                          ({"\n"}
-                                          {"    "}id: $id
-                                          ,{"\n"}
-                                          {"    "}name:{" "}
-                                          $name,{"\n"}
-                                          {"    "}codeHostKind:{" "}
-                                          $codeHostKind,
-                                          {"\n"}
-                                          {"    "}codeHostURN:{" "}
-                                          $codeHostURN,
-                                          {"\n"}
-                                          {"    "}secret:{" "}
-                                          $secret
-                                          {"\n"}
-                                          {"  "})
-                                        {" "}
-                                        
-                                          {"{"}
-                                          {"\n"}
-                                          {"    "}
-                                          id
-                                          {"\n"}
-                                          {"    "}
-                                          uuid
-                                          {"\n"}
-                                          {"    "}
-                                          url
-                                          {"\n"}
-                                          {"    "}
-                                          name
-                                          {"\n"}
-                                          {"    "}
-                                          codeHostKind
-                                          {"\n"}
-                                          {"    "}
-                                          codeHostURN
-                                          {"\n"}
-                                          {"    "}
-                                          secret
-                                          {"\n"}
-                                          {"    "}
-                                          updatedAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            updatedBy{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          createdAt
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            createdBy{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...UserFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"    "}
-                                          
-                                            webhookLogs{" "}
-                                            
-                                              {"{"}
-                                              {"\n"}
-                                              {"      "}
-                                              
-                                                ...WebhookLogConnectionFragment
-                                              
-                                              {"\n"}
-                                              {"    "}
-                                              {"}"}
-                                            
-                                          
-                                          {"\n"}
-                                          {"  "}
-                                          {"}"}
-                                        
-                                      
-                                      {"\n"}
-                                      {"}"}
-                                    
-                                  
-                                  {"\n"}
-                                
-
-
-
-
Variables
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeHostKind"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeHostURN"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "secret"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
Response
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "data"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"    "}
-                                  "updateWebhook"
-                                  :{" "}
-                                  {"{"}
-                                  {"\n"}
-                                  {"      "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "uuid"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "codeHostKind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "codeHostURN"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "secret"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "updatedBy"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "createdBy"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"      "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  {"\n"}
-                                  {"    "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"  "}
-                                  {"}"}
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-

- Types -

-
-

AccessToken

-
-
-
-
Description
-

- An access token that grants to the holder the privileges of - the user who created it. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the access token.
- - subject - {" "} - -{" "} - - - User! - - - - {" "} - The user whose privileges the access token grants.{" "} -
- - scopes - {" "} - -{" "} - - - [String!]! - - - - {" "} - The scopes that define the allowed set of operations - that can be performed using this access token.{" "} -
- - note - {" "} - -{" "} - - - String! - - - - {" "} - A user-supplied descriptive note for the access token.{" "} -
- - creator - {" "} - -{" "} - - - User! - - - - {" "} - The user who created the access token. This is either - the subject user (if the access token was created by - the same user) or a site admin (who can create access - tokens for any user).{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The date when the access token was created.
- - lastUsedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The date when the access token was last used to - authenticate a request.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "subject"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "scopes"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "note"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "creator"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastUsedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AccessTokenConnection

-
-
-
-
Description
-

A list of access tokens.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [AccessToken!]! - - - A list of access tokens.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of access tokens in the connection. - This total count may be larger than the number of - nodes in this object when the result is paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  AccessToken
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AddExternalServiceInput

-
-
-
-
Description
-

A new external service.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - kind - {" "} - -{" "} - - - ExternalServiceKind! - - - The kind of the external service.
- - displayName - {" "} - -{" "} - - - String! - - - The display name of the external service.
- - config - {" "} - -{" "} - - - String! - - - - {" "} - The JSON configuration of the external service.{" "} -
- - namespace - {" "} - -{" "} - - - ID - - - - {" "} - The namespace this external service belongs to. This - can be used both for a user and an organization.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "config"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  4
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Alert

-
-
-
-
Description
-

An alert message shown to the viewer.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - type - {" "} - -{" "} - - - AlertType! - - - The type of this alert.
- - message - {" "} - -{" "} - - - String! - - - - {" "} - The message body of this alert. Markdown is supported.{" "} -
- - isDismissibleWithKey - {" "} - -{" "} - - - String - - - - {" "} - If set, this alert is dismissible. After being - dismissed, no other alerts with the same - isDismissibleWithKey value will be shown. If null, - this alert is not dismissible.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "type"
-                                  :{" "}
-                                  "INFO"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "message"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isDismissibleWithKey"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AlertType

-
-
-
-
Description
-

The possible types of alerts (Alert.type values).

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- INFO -

-
-

- WARNING -

-
-

- ERROR -

-
-
-
-
-
-
Example
- 
-                                
-                                  "INFO"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Analytics

-
-
-
-
Description
-

Analytics describes a new site statistics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - search - {" "} - -{" "} - - - AnalyticsSearchResult! - - - Search statistics.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - notebooks - {" "} - -{" "} - - - AnalyticsNotebooksResults! - - - Notebooks statistics.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - users - {" "} - -{" "} - - - AnalyticsUsersResult! - - - Users statistics.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - codeIntel - {" "} - -{" "} - - - AnalyticsCodeIntelResult! - - - Code-intelligence statistics.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - codeIntelByLanguage - {" "} - -{" "} - - - - [AnalyticsCodeIntelByLanguageResult!]! - - - - - {" "} - Code-intelligence statistics grouped by language and - precision.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
-
- - codeIntelTopRepositories - {" "} - -{" "} - - - - [AnalyticsCodeIntelRepositoryResult!]! - - - - Top repositories by code-intelligence events.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
-
- - repos - {" "} - -{" "} - - - AnalyticsReposSummartResult! - - - Repositories summary statistics.
- - batchChanges - {" "} - -{" "} - - - AnalyticsBatchChangesResult! - - - Batch changes statistics
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - extensions - {" "} - -{" "} - - - AnalyticsExtensionsResult! - - - Extensions statistics
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
- - codeInsights - {" "} - -{" "} - - - AnalyticsCodesInsightsResult! - - - Code insights statistics
-
-
- {" "} - Arguments{" "} -
-
-
-
- - dateRange - {" "} - -{" "} - - - AnalyticsDateRange - - -
-
-
-
- - grouping - {" "} - -{" "} - - - AnalyticsGrouping - - -
-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "search"
-                                  :{" "}
-                                  AnalyticsSearchResult
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "notebooks"
-                                  :{" "}
-                                  
-                                    AnalyticsNotebooksResults
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "users"
-                                  :{" "}
-                                  AnalyticsUsersResult
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeIntel"
-                                  :{" "}
-                                  
-                                    AnalyticsCodeIntelResult
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeIntelByLanguage"
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    AnalyticsCodeIntelByLanguageResult
-                                  
-                                  {"\n"}
-                                  {"  "}
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  
-                                    "codeIntelTopRepositories"
-                                  
-                                  :{" "}
-                                  [
-                                  {"\n"}
-                                  {"    "}
-                                  
-                                    AnalyticsCodeIntelRepositoryResult
-                                  
-                                  {"\n"}
-                                  {"  "}
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repos"
-                                  :{" "}
-                                  
-                                    AnalyticsReposSummartResult
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "batchChanges"
-                                  :{" "}
-                                  
-                                    AnalyticsBatchChangesResult
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "extensions"
-                                  :{" "}
-                                  
-                                    AnalyticsExtensionsResult
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeInsights"
-                                  :{" "}
-                                  
-                                    AnalyticsCodesInsightsResult
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsBatchChangesResult

-
-
-
-
Description
-

Batch changes analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - changesetsCreated - {" "} - -{" "} - - - AnalyticsStatItem! - - - Changesets created
- - changesetsMerged - {" "} - -{" "} - - - AnalyticsStatItem! - - - Changesets merged
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "changesetsCreated"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "changesetsMerged"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- AnalyticsCodeIntelByLanguageResult -

-
-
-
-
Description
-

CodeIntelByLanguage analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - language - {" "} - -{" "} - - - String! - - - Language
- - precision - {" "} - -{" "} - - - String! - - - Precision
- - count - {" "} - -{" "} - - - Float! - - - Count
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "language"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "precision"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "count"
-                                  :{" "}
-                                  123.45
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- AnalyticsCodeIntelRepositoryResult -

-
-
-
-
Description
-

CodeIntelTopRepositories analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - Repository name
- - language - {" "} - -{" "} - - - String! - - - Language
- - kind - {" "} - -{" "} - - - String! - - - Event kind
- - precision - {" "} - -{" "} - - - String! - - - - {" "} - Event precision (either "search-based" or "precise"){" "} -
- - events - {" "} - -{" "} - - - Float! - - - Event count
- - hasPrecise - {" "} - -{" "} - - - Boolean! - - - Has precise
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "language"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "kind"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "precision"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "events"
-                                  :{" "}
-                                  987.65
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasPrecise"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsCodeIntelResult

-
-
-
-
Description
-

CodeIntel' analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - referenceClicks - {" "} - -{" "} - - - AnalyticsStatItem! - - - "GoToRef" click
- - definitionClicks - {" "} - -{" "} - - - AnalyticsStatItem! - - - "GoToDef" click
- - inAppEvents - {" "} - -{" "} - - - AnalyticsStatItem! - - - Code Intel events made from web
- - codeHostEvents - {" "} - -{" "} - - - AnalyticsStatItem! - - - Code Intel events made from code host
- - searchBasedEvents - {" "} - -{" "} - - - AnalyticsStatItem! - - - Search based events
- - preciseEvents - {" "} - -{" "} - - - AnalyticsStatItem! - - - Precise events
- - crossRepoEvents - {" "} - -{" "} - - - AnalyticsStatItem! - - - Cross-repo events
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "referenceClicks"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "definitionClicks"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "inAppEvents"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeHostEvents"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "searchBasedEvents"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "preciseEvents"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "crossRepoEvents"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsCodesInsightsResult

-
-
-
-
Description
-

Code insights analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - insightHovers - {" "} - -{" "} - - - AnalyticsStatItem! - - - Insights hovers statistics.
- - insightDataPointClicks - {" "} - -{" "} - - - AnalyticsStatItem! - - - Insights data point clicks statistics.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "insightHovers"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  
-                                    "insightDataPointClicks"
-                                  
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsDateRange

-
-
-
-
Description
-

A pre-defined periods to get site analytics.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- LAST_THREE_MONTHS -

- 		Last 3 months date range.
-

- LAST_MONTH -

- 		Last month date range.
-

- LAST_WEEK -

- 		Last week date range.
-

- CUSTOM -

- 		Custom date range.
-
-
-
-
-
Example
- 
-                                
-                                  "LAST_THREE_MONTHS"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsExtensionsResult

-
-
-
-
Description
-

Extentions analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - jetbrains - {" "} - -{" "} - - - AnalyticsStatItem! - - - JetBrains IDE plugin search events.
- - vscode - {" "} - -{" "} - - - AnalyticsStatItem! - - - VSCode IDE extension search events.
- - browser - {" "} - -{" "} - - - AnalyticsStatItem! - - - - {" "} - Browser (chrome, firefox, safari) extensions code - navigation events. This includes events like "Go to - Def", "Find ref" and "Find implementation"{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "jetbrains"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "vscode"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "browser"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsGrouping

-
-
-
-
Description
-

Group site analytics by period.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- DAILY -

- 		Group data by day.
-

- WEEKLY -

- 		Group data by week.
-
-
-
-
-
Example
- 
-                                
-                                  "DAILY"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsMonthlyActiveUsers

-
-
-
-
Description
-

Monthly active users

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - date - {" "} - -{" "} - - - String! - - - - {" "} - year-month for which the total active users are - calculated{" "} -
- - count - {" "} - -{" "} - - - Float! - - - total count of active users
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "date"
-                                  :{" "}
-                                  "xyz789"
-                                  ,{" "}
-                                  "count"
-                                  :{" "}
-                                  123.45
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsNotebooksResults

-
-
-
-
Description
-

Notebook analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - creations - {" "} - -{" "} - - - AnalyticsStatItem! - - - Notebooks creation analytics.
- - views - {" "} - -{" "} - - - AnalyticsStatItem! - - - Notebooks views analytics.
- - blockRuns - {" "} - -{" "} - - - AnalyticsStatItem! - - - Notebooks block run analytics.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "creations"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "views"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "blockRuns"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsReposSummartResult

-
-
-
-
Description
-

Repositories summary.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - count - {" "} - -{" "} - - - Float! - - - Total number of repositories.
- - preciseCodeIntelCount - {" "} - -{" "} - - - Float! - - - - {" "} - Total number of repositories with precise code-intel.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "count"
-                                  :{" "}
-                                  123.45
-                                  ,{" "}
-                                  "preciseCodeIntelCount"
-                                  :{" "}
-                                  987.65
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsSearchResult

-
-
-
-
Description
-

Search analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - searches - {" "} - -{" "} - - - AnalyticsStatItem! - - - Searches analytics
- - resultClicks - {" "} - -{" "} - - - AnalyticsStatItem! - - - Search result click analytics
- - fileViews - {" "} - -{" "} - - - AnalyticsStatItem! - - - File view analytics
- - fileOpens - {" "} - -{" "} - - - AnalyticsStatItem! - - - File open analytics
- - codeCopied - {" "} - -{" "} - - - AnalyticsStatItem! - - - Code copied from search results analytics
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "searches"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "resultClicks"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "fileViews"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "fileOpens"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "codeCopied"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsStatItem

-
-
-
-
Description
-

Analytics result item.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - summary - {" "} - -{" "} - - - AnalyticsStatItemSummary! - - - Analytics summary.
- - nodes - {" "} - -{" "} - - - [AnalyticsStatItemNode!]! - - - Array of analytics by period.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "summary"
-                                  :{" "}
-                                  
-                                    AnalyticsStatItemSummary
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  AnalyticsStatItemNode
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsStatItemNode

-
-
-
-
Description
-

Analytics for certain date.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - date - {" "} - -{" "} - - - String! - - - A date in ISO format
- - count - {" "} - -{" "} - - - Float! - - - Total number of events.
- - uniqueUsers - {" "} - -{" "} - - - Float! - - - - {" "} - Unique number of users who triggered event. This - counts deleted users as well as anonymous users.{" "} -
- - registeredUsers - {" "} - -{" "} - - - Float! - - - - {" "} - Unique number of currently registered users who - triggered event.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "date"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "count"
-                                  :{" "}
-                                  987.65
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "uniqueUsers"
-                                  :{" "}
-                                  123.45
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "registeredUsers"
-                                  :{" "}
-                                  987.65
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsStatItemSummary

-
-
-
-
Description
-

Analytics summary.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - totalCount - {" "} - -{" "} - - - Float! - - - Total number of events.
- - totalUniqueUsers - {" "} - -{" "} - - - Float! - - - - {" "} - Total unique number of users who triggered event. This - counts deleted users as well as anonymous users.{" "} -
- - totalRegisteredUsers - {" "} - -{" "} - - - Float! - - - - {" "} - Total unique number of currently registered users who - triggered event.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123.45
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalUniqueUsers"
-                                  :{" "}
-                                  123.45
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalRegisteredUsers"
-                                  :{" "}
-                                  123.45
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsUsersFrequencyItem

-
-
-
-
Description
-

Users frequency by days used.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - daysUsed - {" "} - -{" "} - - - Float! - - - Number of days used
- - frequency - {" "} - -{" "} - - - Float! - - - Number of users.
- - percentage - {" "} - -{" "} - - - Float! - - - Percentage of users from total frequencies.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "daysUsed"
-                                  :{" "}
-                                  123.45
-                                  ,{" "}
-                                  "frequency"
-                                  :{" "}
-                                  987.65
-                                  ,{" "}
-                                  "percentage"
-                                  :{" "}
-                                  987.65
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AnalyticsUsersResult

-
-
-
-
Description
-

Users' analytics.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - activity - {" "} - -{" "} - - - AnalyticsStatItem! - - - Users' activity analytics.
- - frequencies - {" "} - -{" "} - - - [AnalyticsUsersFrequencyItem!]! - - - Frequency of usage by day.
- - monthlyActiveUsers - {" "} - -{" "} - - - [AnalyticsMonthlyActiveUsers!]! - - - Monthly active users for last 3 months.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "activity"
-                                  :{" "}
-                                  AnalyticsStatItem
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "frequencies"
-                                  :{" "}
-                                  [
-                                  
-                                    AnalyticsUsersFrequencyItem
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "monthlyActiveUsers"
-                                  :{" "}
-                                  [
-                                  
-                                    AnalyticsMonthlyActiveUsers
-                                  
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AuthProvider

-
-
-
-
Description
-

- A provider of user authentication, such as an external - single-sign-on service (e.g., using OpenID Connect or SAML). - The provider information in this type is visible to all - viewers and does not contain any secret values. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - serviceType - {" "} - -{" "} - - - String! - - - The type of the auth provider.
- - serviceID - {" "} - -{" "} - - - String! - - - - {" "} - An identifier for the service that the auth provider - represents.{" "} -
- - clientID - {" "} - -{" "} - - - String! - - - - {" "} - An identifier for the client of the service that the - auth provider represents.{" "} -
- - displayName - {" "} - -{" "} - - - String! - - - The human-readable name of the provider.
- - isBuiltin - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether this auth provider is the builtin - username-password auth provider.{" "} -
- - authenticationURL - {" "} - -{" "} - - - String - - - - {" "} - A URL that, when visited, initiates the authentication - process for this auth provider.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceType"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "clientID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isBuiltin"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "authenticationURL"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AuthProviderConnection

-
-
-
-
Description
-

A list of authentication providers.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [AuthProvider!]! - - - A list of authentication providers.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of authentication providers in the - connection. This total count may be larger than the - number of nodes in this object when the result is - paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  AuthProvider
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

AutocompleteMemberSearchItem

-
-
-
-
Description
-

- Result user returned by invite members autocomplete search. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the user.
- - username - {" "} - -{" "} - - - String! - - - The user's username.
- - displayName - {" "} - -{" "} - - - String - - - The display name chosen by the user.
- - avatarURL - {" "} - -{" "} - - - String - - - The URL of the user's avatar image.
- - inOrg - {" "} - -{" "} - - - Boolean - - - If the user belongs to current Organization.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "username"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "avatarURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "inOrg"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundJob

-
-
-
-
Description
-

A single background job.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The background job ID.
- - name - {" "} - -{" "} - - - String! - - - The name of the job.
- - routines - {" "} - -{" "} - - - [BackgroundRoutine!]! - - - The routines that run inside this job.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "routines"
-                                  :{" "}
-                                  [
-                                  BackgroundRoutine
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundJobConnection

-
-
-
-
Description
-

- A list of background jobs that are currently known in the - system -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [BackgroundJob!]! - - - A list of outbound requests.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of outbound request log items in the - connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  BackgroundJob
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundRoutine

-
-
-
-
Description
-

A routine that runs inside a background job.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the routine.
- - type - {" "} - -{" "} - - - BackgroundRoutineType! - - - - {" "} - Tells whether this is a periodic goroutine, a DB - worker, or something else{" "} -
- - description - {" "} - -{" "} - - - String! - - - Explains what the routine does.
- - intervalMs - {" "} - -{" "} - - - Int - - - - {" "} - The interval at which the routine runs, if it's - periodic.{" "} -
- - instances - {" "} - -{" "} - - - [BackgroundRoutineInstance!]! - - - - {" "} - The instances of this routine that are running or ran - recently. An instance means one routine on one host.{" "} -
- - recentRuns - {" "} - -{" "} - - - [BackgroundRoutineRecentRun!]! - - - The recent runs of this routine.
- - stats - {" "} - -{" "} - - - BackgroundRoutineStats! - - - - {" "} - Some stats of the runs of this routine in the past few - days.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "type"
-                                  :{" "}
-                                  "PERIODIC"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "description"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "intervalMs"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "instances"
-                                  :{" "}
-                                  [
-                                  
-                                    BackgroundRoutineInstance
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "recentRuns"
-                                  :{" "}
-                                  [
-                                  
-                                    BackgroundRoutineRecentRun
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "stats"
-                                  :{" "}
-                                  
-                                    BackgroundRoutineStats
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundRoutineInstance

-
-
-
-
Description
-

- One instance of the background routine, running on a host. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - hostName - {" "} - -{" "} - - - String! - - - The ID of the instance.
- - lastStartedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The time the instance was last started. (If it's - unknown, this will be null.){" "} -
- - lastStoppedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The time the instance was last stopped. (If it's - unknown, this will be null.){" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "hostName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastStartedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastStoppedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundRoutineRecentRun

-
-
-
-
Description
-

- A single run of the routine. A run is not the start/stop - event but the actual execution of the routine handler. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - at - {" "} - -{" "} - - - DateTime! - - - The time the run started.
- - hostName - {" "} - -{" "} - - - String! - - - The name of the host that ran the routine.
- - durationMs - {" "} - -{" "} - - - Int! - - - The duration of the run.
- - errorMessage - {" "} - -{" "} - - - String - - - The error message, if any.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "at"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hostName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "durationMs"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "errorMessage"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundRoutineStats

-
-
-
-
Description
-

Holds statistics about a background routine.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - since - {" "} - -{" "} - - - DateTime - - - - {" "} - The start of the earliest day for which we have any - runs registered.{" "} -
- - runCount - {" "} - -{" "} - - - Int! - - - - {" "} - The number of times the routine ran in the period.{" "} -
- - errorCount - {" "} - -{" "} - - - Int! - - - - {" "} - The number of times the routine run ended with an - error.{" "} -
- - minDurationMs - {" "} - -{" "} - - - Int! - - - - {" "} - The minimum duration of a run, in milliseconds.{" "} -
- - avgDurationMs - {" "} - -{" "} - - - Int! - - - - {" "} - The average duration of a run, in milliseconds.{" "} -
- - maxDurationMs - {" "} - -{" "} - - - Int! - - - - {" "} - The maximum duration of a run, in milliseconds.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "since"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "runCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "errorCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "minDurationMs"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "avgDurationMs"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "maxDurationMs"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BackgroundRoutineType

-
-
-
-
Description
-

Enum of the possible background routine types

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- PERIODIC -

- 		Periodic routine
-

- PERIODIC_WITH_METRICS -

- 		Periodic routine with metrics set up
-

- DB_BACKED -

- 		DB-backed worker
-

- CUSTOM -

- 		Custom routine
-
-
-
-
-
Example
- 
-                                
-                                  "PERIODIC"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BehindAheadCounts

-
-
-
-
Description
-

- A set of Git behind/ahead counts for one commit relative to - another. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - behind - {" "} - -{" "} - - - Int! - - - - {" "} - The number of commits behind the other commit.{" "} -
- - ahead - {" "} - -{" "} - - - Int! - - - - {" "} - The number of commits ahead of the other commit.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "behind"
-                                  :{" "}
-                                  987
-                                  ,{" "}
-                                  "ahead"
-                                  :{" "}
-                                  123
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BidirectionalPageInfo

-
-
-
-
Description
-

- Pagination information for bi-directional pagination. See{" "} - - https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo - - . -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - startCursor - {" "} - -{" "} - - - String - - - - {" "} - When paginating backwards, the cursor to continue.{" "} -
- - endCursor - {" "} - -{" "} - - - String - - - - {" "} - When paginating forwards, the cursor to continue.{" "} -
- - hasPreviousPage - {" "} - -{" "} - - - Boolean! - - - - {" "} - When paginating backwards, are there more items?{" "} -
- - hasNextPage - {" "} - -{" "} - - - Boolean! - - - - {" "} - When paginating forwards, are there more items?{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "startCursor"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "endCursor"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasPreviousPage"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasNextPage"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

BigInt

-
-
-
-
Description
-

- An arbitrarily large integer encoded as a decimal string. -

-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Boolean

-
-
-
-
Description
-

- The Boolean scalar type represents{" "} - true or false. -

-
-
-
-
-
-
-
- Types -
-

- CheckMirrorRepositoryConnectionResult -

-
-
-
-
Description
-

- The result for Mutation.checkMirrorRepositoryConnection. -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - error - {" "} - -{" "} - - - String - - - - {" "} - The error message encountered during the update - operation, if any. If null, then the connection check - succeeded.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "error"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ChunkMatch

-
-
-
-
Description
-

- A set of matched ranges contained in a chunk of contiguous - lines. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - content - {" "} - -{" "} - - - String! - - - - {" "} - The contiguous set of full lines which contain the - matches in ranges.{" "} -
- - contentStart - {" "} - -{" "} - - - Position! - - - The location of the beginning of content.
- - ranges - {" "} - -{" "} - - - [Range!]! - - - - {" "} - The set of ranges within the content that matched the - search query.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "content"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "contentStart"
-                                  :{" "}
-                                  Position
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "ranges"
-                                  :{" "}
-                                  [
-                                  Range
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ClientConfigurationDetails

-
-
-
-
Description
-

- Configuration details for the browser extension, editor - extensions, etc. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - contentScriptUrls - {" "} - -{" "} - - - [String!]! - - - - {" "} - The list of phabricator/gitlab/bitbucket/etc instance - URLs that specifies which pages the content script - will be injected into.{" "} -
- - parentSourcegraph - {" "} - -{" "} - - - ParentSourcegraphDetails! - - - - {" "} - Returns details about the parent Sourcegraph instance.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "contentScriptUrls"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parentSourcegraph"
-                                  :{" "}
-                                  
-                                    ParentSourcegraphDetails
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CloneStatus

-
-
-
-
Description
-

The clone status of a repository.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- NOT_CLONED -

-
-

- CLONING -

-
-

- CLONED -

-
-
-
-
-
-
Example
- 
-                                
-                                  "NOT_CLONED"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CloningProgress

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: A status message produced when - repositories are being cloned -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - message - {" "} - -{" "} - - - String! - - - The message of this status message
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "message"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CodeIntelCommit

-
-
-
-
Description
-

A Code Intel Commit.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The globally addressable ID for this commit.
- - oid - {" "} - -{" "} - - - GitObjectID! - - - - {" "} - This commit's Git object ID (OID), a 40-character - SHA-1 hash.{" "} -
- - abbreviatedOID - {" "} - -{" "} - - - String! - - - The abbreviated form of this commit's OID.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this commit (using the input revision - specifier, which may not be immutable).{" "} -
- - repository - {" "} - -{" "} - - - CodeIntelRepository! - - - The repository that contains this commit.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "oid"
-                                  :{" "}
-                                  GitObjectID
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "abbreviatedOID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  CodeIntelRepository
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CodeIntelExternalRepository

-
-
-
-
Description
-

- A repository on an external service (such as GitHub, GitLab, - Phabricator, etc.). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - serviceType - {" "} - -{" "} - - - String! - - - - {" "} - The type of external service where this repository - resides. Example: "github", "gitlab", etc.{" "} -
- - serviceID - {" "} - -{" "} - - - String! - - - - {" "} - The particular instance of the external service where - this repository resides. Its value is opaque but - typically consists of the canonical base URL to the - service. Example: For GitHub.com, this is " - https://github.com/ - ".{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceType"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceID"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CodeIntelGitBlob

-
-
-
-
Description
-

A gitblob resolver specific to code intel.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the root) of this tree.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., last path component only) of this - tree.{" "} -
- - commit - {" "} - -{" "} - - - CodeIntelCommit! - - - The Git commit containing this tree.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this tree (using the input revision - specifier, which may not be immutable).{" "} -
- - repository - {" "} - -{" "} - - - CodeIntelRepository! - - - The repository containing this tree.
- - content - {" "} - -{" "} - - - String! - - - The content of this blob.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return file content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return file content ending at line "endLine". - A value < 0 or > totalLines will set - endLine to the end of the file. -

-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "path"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "commit"
-                                  :{" "}
-                                  CodeIntelCommit
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  CodeIntelRepository
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "content"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CodeIntelRepository

-
-
-
-
Description
-

- A codeintel repository is a Git source control repository - that is mirrored from some origin code host and it is - specific to code intel. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The globally addressable ID for this commit.
- - name - {" "} - -{" "} - - - String! - - - -

- The repository's name, as a path with one or more - components. It conventionally consists of the - repository's hostname and path (joined by "/"), - minus any suffixes (such as ".git"). Examples: -

-
    -
  • github.com/foo/bar
    • -
  • my-code-host.example.com/myrepo
    • -
  • myrepo
    • -
-
- - url - {" "} - -{" "} - - - String! - - - The URL to this repository.
- - externalRepository - {" "} - -{" "} - - - CodeIntelExternalRepository - - - - {" "} - Information about this repository from the external - service that it originates from (such as GitHub, - GitLab, Phabricator, etc.). Only populated when used - as part of repository list previews for configuration - policies.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalRepository"
-                                  :{" "}
-                                  
-                                    CodeIntelExternalRepository
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CodeIntelligenceCommitGraph

-
-
-
-
Description
-

- Information and status related to the commit graph of this - repository calculated for use by code intelligence features. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - stale - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether or not the commit graph needs to be updated.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - When, if ever, the commit graph was last refreshed.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "stale"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CommitSearchResult

-
-
-
-
Description
-

A search result that is a Git commit.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - label - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string that is rendered prominently.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL of the result.
- - detail - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string of that is rendered less - prominently.{" "} -
- - matches - {" "} - -{" "} - - - [SearchResultMatch!]! - - - The result previews of the result.
- - commit - {" "} - -{" "} - - - GitCommit! - - - The commit that matched the search query.
- - refs - {" "} - -{" "} - - - [GitRef!]! - - - The ref names of the commit.
- - sourceRefs - {" "} - -{" "} - - - [GitRef!]! - - - The refs by which this commit was reached.
- - messagePreview - {" "} - -{" "} - - - HighlightedString - - - - {" "} - The matching portion of the commit message, if any.{" "} -
- - diffPreview - {" "} - -{" "} - - - HighlightedString - - - The matching portion of the diff, if any.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "label"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "detail"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "matches"
-                                  :{" "}
-                                  [
-                                  SearchResultMatch
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "commit"
-                                  :{" "}
-                                  GitCommit
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "refs"
-                                  :{" "}
-                                  [
-                                  GitRef
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "sourceRefs"
-                                  :{" "}
-                                  [
-                                  GitRef
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "messagePreview"
-                                  :{" "}
-                                  HighlightedString
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "diffPreview"
-                                  :{" "}
-                                  HighlightedString
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Configuration

-
-
-
-
Description
-

- DEPRECATED: Use the contents field on the parent type - instead. This type will be removed in a future release. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - contents - {" "} - -{" "} - - - JSONCString! - - - - {" "} - DEPRECATED: This field will be removed in a future - release. The raw JSON contents, encoded as a string.{" "} - - use the contents field on the parent type instead - -
- - messages - {" "} - -{" "} - - - [String!]! - - - - {" "} - DEPRECATED: This field is always empty. It will be - removed in a future release.{" "} - - use client-side JSON Schema validation instead - -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "contents"
-                                  :{" "}
-                                  JSONCString
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "messages"
-                                  :{" "}
-                                  [
-                                  "xyz789"
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ConfigurationCascade

-
-
-
-
Description
-

DEPRECATED: Renamed to SettingsCascade.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - subjects - {" "} - -{" "} - - - [SettingsSubject!]! - - - - {" "} - DEPRECATED{" "} - - use SettingsCascade.subjects instead - -
- - merged - {" "} - -{" "} - - - Configuration! - - - - {" "} - DEPRECATED{" "} - - use SettingsCascade.final instead - -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "subjects"
-                                  :{" "}
-                                  [
-                                  SettingsSubject
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "merged"
-                                  :{" "}
-                                  Configuration
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ConfigurationEdit

-
-
-
-
Description
-

- DEPRECATED: This type was renamed to SettingsEdit. NOTE: - GraphQL does not support @deprecated directives on - INPUT_FIELD_DEFINITION (input fields). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - keyPath - {" "} - -{" "} - - - [KeyPathSegment!]! - - - DEPRECATED
- - value - {" "} - -{" "} - - - JSONValue - - - DEPRECATED
- - valueIsJSONCEncodedString - {" "} - -{" "} - - - Boolean - - - - {" "} - DEPRECATED. Default = false{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "keyPath"
-                                  :{" "}
-                                  [
-                                  KeyPathSegment
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  JSONValue
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  
-                                    "valueIsJSONCEncodedString"
-                                  
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Connection

-
-
-
-
Description
-

An object with totalCount and PageInfo.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - totalCount - {" "} - -{" "} - - - Int! - - - The total count of items in the connection.
- - pageInfo - {" "} - -{" "} - - - ConnectionPageInfo! - - - The pagination info for the connection.
-
-
-
Possible Types
- - - - - - - - - - - - - - - - - -
Connection Types
-

- - SavedSearchesConnection - -

-
-

- - NewUsersConnection - -

-
-

- - SiteConfigurationChangeConnection - -

-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,{" "}
-                                  "pageInfo"
-                                  :{" "}
-                                  ConnectionPageInfo
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ConnectionPageInfo

-
-
-
-
Description
-

Pagination information.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - endCursor - {" "} - -{" "} - - - String - - - - {" "} - When paginating forwards, the cursor to continue.{" "} -
- - hasNextPage - {" "} - -{" "} - - - Boolean! - - - - {" "} - When paginating forwards, are there more items?{" "} -
- - startCursor - {" "} - -{" "} - - - String - - - - {" "} - When paginating backward, the cursor to continue.{" "} -
- - hasPreviousPage - {" "} - -{" "} - - - Boolean! - - - - {" "} - When paginating backward, are there more items?{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "endCursor"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasNextPage"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "startCursor"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasPreviousPage"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CreateAccessTokenResult

-
-
-
-
Description
-

The result for Mutation.createAccessToken.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the newly created access token.
- - token - {" "} - -{" "} - - - String! - - - - {" "} - The secret token value that is used to authenticate - API clients. The caller is responsible for storing - this value.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "token"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

CreateUserResult

-
-
-
-
Description
-

The result for Mutation.createUser.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - user - {" "} - -{" "} - - - User! - - - The new user.
- - resetPasswordURL - {" "} - -{" "} - - - String - - - -

- The reset password URL that the new user must visit - to sign into their account. If the builtin - username-password authentication provider is not - enabled, this field's value is null. -

-

- If email sending (SMTP) is configured on this - instance and an email was provided, an email - containing this URL will also be sent to the primary - email address associated with the user. -

-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "resetPasswordURL"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

DateTime

-
-
-
-
Description
-

- An RFC 3339-encoded UTC date string, such as - 1973-11-29T21:33:09Z. This value can be parsed into a - JavaScript Date using Date.parse. To produce this value from - a JavaScript Date instance, use Date#toISOString. -

-
-
-
-
-
Example
- 
-                                
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

DefaultSettings

-
-
-
-
Description
-

- The default settings for the Sourcegraph instance. This is - hardcoded in Sourcegraph, but may change from release to - release. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The opaque GraphQL ID.
- - latestSettings - {" "} - -{" "} - - - Settings - - - - {" "} - The latest default settings (this never changes).{" "} -
- - settingsURL - {" "} - -{" "} - - - String - - - - {" "} - The URL to the default settings. This URL does not - exist because you cannot edit or directly view default - settings.{" "} -
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer can modify the subject's settings. - Always false for default settings.{" "} -
- - settingsCascade - {" "} - -{" "} - - - SettingsCascade! - - - - {" "} - The default settings, and the final merged settings. - All viewers can access this field.{" "} -
- - configurationCascade - {" "} - -{" "} - - - ConfigurationCascade! - - - - {" "} - DEPRECATED{" "} - - Use settingsCascade instead. This field is a - deprecated alias for it and will be removed in a - future release. - -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "latestSettings"
-                                  :{" "}
-                                  Settings
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "settingsURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "viewerCanAdminister"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "settingsCascade"
-                                  :{" "}
-                                  SettingsCascade
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "configurationCascade"
-                                  :{" "}
-                                  ConfigurationCascade
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

DiffHunkLineType

-
-
-
-
Description
-

The type of content in a hunk line.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- ADDED -

- 		Added line.
-

- UNCHANGED -

- 		Unchanged line.
-

- DELETED -

- 		Deleted line.
-
-
-
-
-
Example
- 
-                                
-                                  "ADDED"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

DiffStat

-
-
-
-
Description
-

Statistics about a diff.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - added - {" "} - -{" "} - - - Int! - - - Number of lines added.
- - deleted - {" "} - -{" "} - - - Int! - - - Number of lines deleted.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "added"
-                                  :{" "}
-                                  987
-                                  ,{" "}
-                                  "deleted"
-                                  :{" "}
-                                  987
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

EmptyResponse

-
-
-
-
Description
-

Represents a null return value.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - alwaysNil - {" "} - -{" "} - - - String - - - A dummy null value.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "alwaysNil"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

EvaluatedFeatureFlag

-
-
-
-
Description
-

- An evaluated feature flag is any feature flag (static or - random) that has been evaluated to a concrete value for a - given viewer. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
- - value - {" "} - -{" "} - - - Boolean! - - - - {" "} - The concrete evaluated value of the feature flag{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,{" "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Event

-
-
-
-
Description
-

A description of a user event.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - event - {" "} - -{" "} - - - String! - - - The name of the event.
- - userCookieID - {" "} - -{" "} - - - String! - - - - {" "} - The randomly generated unique user ID stored in a - browser cookie.{" "} -
- - firstSourceURL - {" "} - -{" "} - - - String - - - - {" "} - The first sourcegraph URL visited by the user, stored - in a browser cookie.{" "} -
- - lastSourceURL - {" "} - -{" "} - - - String - - - - {" "} - The last sourcegraph URL visited by the user, stored - in a browser cookie.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL when the event was logged.
- - source - {" "} - -{" "} - - - EventSource! - - - The source of the event.
- - cohortID - {" "} - -{" "} - - - String - - - - {" "} - An optional cohort ID to identify the user as part of - a specific A/B test. The cohort ID is expected to be a - date in the form YYYY-MM-DD{" "} -
- - referrer - {" "} - -{" "} - - - String - - - - {" "} - An optional referrer parameter for the user's current - session. Only captured and stored on Sourcegraph - Cloud.{" "} -
- - originalReferrer - {" "} - -{" "} - - - String - - - The original referrer for a user
- - sessionReferrer - {" "} - -{" "} - - - String - - - The session referrer for a user
- - sessionFirstURL - {" "} - -{" "} - - - String - - - The sessions first url for a user
- - deviceSessionID - {" "} - -{" "} - - - String - - - - {" "} - Device session ID to identify the user's session for - analytics.{" "} -
- - argument - {" "} - -{" "} - - - String - - - The additional argument information.
- - publicArgument - {" "} - -{" "} - - - String - - - - {" "} - Public argument information. PRIVACY: Do NOT include - any potentially private information in this field. - These properties get sent to our analytics tools for - Cloud, so must not include private information, such - as search queries or repository names.{" "} -
- - deviceID - {" "} - -{" "} - - - String - - - - {" "} - Device ID used for Amplitude analytics. Used on - Sourcegraph Cloud only.{" "} -
- - eventID - {" "} - -{" "} - - - Int - - - - {" "} - Event ID used to deduplicate events that occur - simultaneously in Amplitude analytics. See{" "} - - https://developers.amplitude.com/docs/http-api-v2#optional-keys - - . Used on Sourcegraph Cloud only.{" "} -
- - insertID - {" "} - -{" "} - - - String - - - - {" "} - Insert ID used to deduplicate events that re-occur in - the event of retries or backfills in Amplitude - analytics. See{" "} - - https://developers.amplitude.com/docs/http-api-v2#optional-keys - - . Used on Sourcegraph Cloud only.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "event"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "userCookieID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "firstSourceURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastSourceURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "source"
-                                  :{" "}
-                                  "WEB"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "cohortID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "referrer"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "originalReferrer"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "sessionReferrer"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "sessionFirstURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "deviceSessionID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "argument"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "publicArgument"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "deviceID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "eventID"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "insertID"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

EventLog

-
-
-
-
Description
-

A single user event that has been logged.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the event.
- - user - {" "} - -{" "} - - - User - - - - {" "} - The user who executed the event, if one exists.{" "} -
- - anonymousUserID - {" "} - -{" "} - - - String! - - - - {" "} - The randomly generated unique user ID stored in a - browser cookie.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL when the event was logged.
- - source - {" "} - -{" "} - - - EventSource! - - - The source of the event.
- - argument - {" "} - -{" "} - - - String - - - The additional argument information.
- - version - {" "} - -{" "} - - - String! - - - - {" "} - The Sourcegraph version when the event was logged.{" "} -
- - timestamp - {" "} - -{" "} - - - DateTime! - - - The timestamp when the event was logged.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "anonymousUserID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "source"
-                                  :{" "}
-                                  "WEB"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "argument"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "version"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "timestamp"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

EventLogsConnection

-
-
-
-
Description
-

A list of event logs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [EventLog!]! - - - A list of event logs.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of event logs in the connection. This - total count may be larger than the number of nodes in - this object when the result is paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  EventLog
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

EventSource

-
-
-
-
Description
-

The product sources where events can come from.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- WEB -

-
-

- CODEHOSTINTEGRATION -

-
-

- BACKEND -

-
-

- STATICWEB -

-
-

- IDEEXTENSION -

-
-
-
-
-
-
Example
- 
-                                
-                                  "WEB"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Executor

-
-
-
-
Description
-

An active executor compute instance.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique identifier of this executor.
- - hostname - {" "} - -{" "} - - - String! - - - The hostname of the executor instance.
- - queueName - {" "} - -{" "} - - - String! - - - - {" "} - The queue name that the executor polls for work.{" "} -
- - active - {" "} - -{" "} - - - Boolean! - - - - {" "} - Active is true, if a heartbeat from the executor has - been received at most three heartbeat intervals ago.{" "} -
- - os - {" "} - -{" "} - - - String! - - - The operating system running the executor.
- - architecture - {" "} - -{" "} - - - String! - - - - {" "} - The machine architecture running the executor.{" "} -
- - dockerVersion - {" "} - -{" "} - - - String! - - - The version of Git used by the executor.
- - executorVersion - {" "} - -{" "} - - - String! - - - The version of the executor.
- - gitVersion - {" "} - -{" "} - - - String! - - - The version of Docker used by the executor.
- - igniteVersion - {" "} - -{" "} - - - String! - - - The version of Ignite used by the executor.
- - srcCliVersion - {" "} - -{" "} - - - String! - - - The version of src-cli used by the executor.
- - firstSeenAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The first time the executor sent a heartbeat to the - Sourcegraph instance.{" "} -
- - lastSeenAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The last time the executor sent a heartbeat to the - Sourcegraph instance.{" "} -
- - compatibility - {" "} - -{" "} - - - ExecutorCompatibility - - - -

- The compatibility of the executor with respect to - the Sourcegraph instance. If outdated, please make - sure that the executor and the Sourcegraph backend - are of compatible versions. This means they should - match in major and minor version, but they may be 1 - minor version apart. If too new, please update the - Sourcegraph instance to match the version of the - executor or downgrade the executor. -

-

- Compatibility can be null if the executor or - Sourcegraph instance runs in dev mode or there's a - version mismatch. -

-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hostname"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "queueName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "active"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "os"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "architecture"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "dockerVersion"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "executorVersion"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "gitVersion"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "igniteVersion"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "srcCliVersion"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "firstSeenAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastSeenAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "compatibility"
-                                  :{" "}
-                                  "OUTDATED"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorCompatibility

-
-
-
-
Description
-

- The compatibility of the executor with the sourcegraph - instance. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- OUTDATED -

- 		- {" "} - Executor version is more than one version behind the - Sourcegraph instance.{" "} -
-

- UP_TO_DATE -

- 		- {" "} - Executor is up-to-date with the Sourcegraph instance.{" "} -
-

- VERSION_AHEAD -

- 		- {" "} - Executor version is more than one version ahead of the - Sourcegraph instance.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  "OUTDATED"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorConnection

-
-
-
-
Description
-

A list of active executors compute instances.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [Executor!]! - - - A list of executors.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of executors in this result set.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  Executor
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorSecret

-
-
-
-
Description
-

A secret to be used in executor jobs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique identifier of the secret.
- - key - {" "} - -{" "} - - - String! - - - - {" "} - The key under which the secret is available. Secrets - are usually exposed as environment variables named - using this key. Recommended format: uppercase letters, - numbers and underscores.{" "} -
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - - - {" "} - The scope of this secret. The secret will only be - usable for jobs in this particular scope.{" "} -
- - overwritesGlobalSecret - {" "} - -{" "} - - - Boolean! - - - - {" "} - If true, this secret is defined in a namespace and a - secret with the same key is also defined in the global - namespace, which this secret overwrites.{" "} -
- - namespace - {" "} - -{" "} - - - Namespace - - - - {" "} - The namespace this secret belongs to. Null, if a - global secret. Global secrets are available to every - execution.{" "} -
- - creator - {" "} - -{" "} - - - User - - - - {" "} - The creator of the secret. Null, if the creator has - been deleted.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The date and time this secret has been created.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The date and time this secret has been last updated.{" "} -
- - accessLogs - {" "} - -{" "} - - - ExecutorSecretAccessLogConnection! - - - - {" "} - The list of access events to this secret. Every time - the secret value is decoded and used, one of these - entries is created.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Only return N records.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque cursor for pagination.

-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "key"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "scope"
-                                  :{" "}
-                                  "BATCHES"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  
-                                    "overwritesGlobalSecret"
-                                  
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "creator"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "accessLogs"
-                                  :{" "}
-                                  
-                                    ExecutorSecretAccessLogConnection
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorSecretAccessLog

-
-
-
-
Description
-

- An access log entry for an executor secret. These are - created every time the secret value is decoded. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique identifier of the log entry.
- - executorSecret - {" "} - -{" "} - - - ExecutorSecret! - - - The secret that this log entry belongs to.
- - user - {" "} - -{" "} - - - User - - - - {" "} - The user in which name the secret has been used. This - is null when the access was not by a user account, or - when the user account was deleted.{" "} -
- - machineUser - {" "} - -{" "} - - - String! - - - - {" "} - True when the secret was accessed by an internal - procedure.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The date and time when the secret has been used.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "executorSecret"
-                                  :{" "}
-                                  ExecutorSecret
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "machineUser"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- ExecutorSecretAccessLogConnection -

-
-
-
-
Description
-

A list of executor secret access logs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExecutorSecretAccessLog!]! - - - A list of access logs.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of records in this result set.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  
-                                    ExecutorSecretAccessLog
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorSecretConnection

-
-
-
-
Description
-

A list of executor secrets.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExecutorSecret!]! - - - A list of executor secrets.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of records in this result set.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  ExecutorSecret
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExecutorSecretScope

-
-
-
-
Description
-

Enum of the possible scopes for executor secrets.

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- BATCHES -

- 		- {" "} - The secret is meant to be used with Batch Changes - execution.{" "} -
-

- CODEINTEL -

- 		- {" "} - The secret is meant to be used with Auto-indexing.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  "BATCHES"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExtensionManifest

-
-
-
-
Description
-

- A description of the extension, how to run or access it, and - when to activate it. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - raw - {" "} - -{" "} - - - String! - - - - {" "} - The raw JSON (or JSONC) contents of the manifest. This - value may be large (because many manifests contain - README and icon data), and it is JSONC (not strict - JSON), which means it must be parsed with a JSON - parser that supports trailing commas and comments. - Consider using jsonFields instead.{" "} -
- - jsonFields - {" "} - -{" "} - - - JSONValue! - - - - {" "} - The manifest as JSON (not JSONC, even if the raw - manifest is JSONC) with only the specified fields. - This is useful for callers that only need certain - fields and want to avoid fetching a large amount of - data (because many manifests contain README and icon - data).{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - fields - {" "} - -{" "} - - - [String!]! - - -
-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "raw"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "jsonFields"
-                                  :{" "}
-                                  JSONValue
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExtensionRegistry

-
-
-
-
Description
-

An extension registry.

-
-
-
Fields
- - - - - - - - - - - - - - - - -
Field NameDescription
- - extensions - {" "} - -{" "} - - - RegistryExtensionConnection! - - - - {" "} - A list of extensions published in the extension - registry.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n extensions from the list. -

-
-
-
- - extensionIDs - {" "} - -{" "} - - - [String!] - - -
-

- Returns only extensions with the given IDs. -

-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "extensions"
-                                  :{" "}
-                                  
-                                    RegistryExtensionConnection
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalAccount

-
-
-
-
Description
-

An external account associated with a user.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the external account.
- - user - {" "} - -{" "} - - - User! - - - The user on Sourcegraph.
- - serviceType - {" "} - -{" "} - - - String! - - - - {" "} - The type of the external service where the external - account resides.{" "} -
- - serviceID - {" "} - -{" "} - - - String! - - - - {" "} - An identifier for the external service where the - external account resides.{" "} -
- - clientID - {" "} - -{" "} - - - String! - - - - {" "} - An identifier for the client of the external service - where the external account resides. This distinguishes - among multiple authentication providers that access - the same service with different parameters.{" "} -
- - accountID - {" "} - -{" "} - - - String! - - - - {" "} - An identifier for the external account (typically - equal to or derived from the ID on the external - service).{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The creation date of this external account on - Sourcegraph.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The last-updated date of this external account on - Sourcegraph.{" "} -
- - refreshURL - {" "} - -{" "} - - - String - - - - {" "} - A URL that, when visited, re-initiates the - authentication process.{" "} -
- - accountData - {" "} - -{" "} - - - JSONValue - - - - {" "} - Provider-specific data about the external account. - Only site admins may query this field.{" "} -
- - publicAccountData - {" "} - -{" "} - - - PublicExternalAccountData - - - - {" "} - Public provider-specific data about the external - account. Only users that are linked to the external - account and site admins may query this field.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "user"
-                                  :{" "}
-                                  User
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceType"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "clientID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "accountID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "refreshURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "accountData"
-                                  :{" "}
-                                  JSONValue
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "publicAccountData"
-                                  :{" "}
-                                  
-                                    PublicExternalAccountData
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalAccountConnection

-
-
-
-
Description
-

A list of external accounts.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExternalAccount!]! - - - A list of external accounts.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of external accounts in the - connection. This total count may be larger than the - number of nodes in this object when the result is - paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  ExternalAccount
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
- -
-
- Types -
-

ExternalRepository

-
-
-
-
Description
-

- A repository on an external service (such as GitHub, GitLab, - Phabricator, etc.). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - String! - - - - {" "} - The repository's ID on the external service. Example: - For GitHub, this is the GitHub GraphQL API's node ID - for the repository.{" "} -
- - serviceType - {" "} - -{" "} - - - String! - - - - {" "} - The type of external service where this repository - resides. Example: "github", "gitlab", etc.{" "} -
- - serviceID - {" "} - -{" "} - - - String! - - - - {" "} - The particular instance of the external service where - this repository resides. Its value is opaque but - typically consists of the canonical base URL to the - service. Example: For GitHub.com, this is " - https://github.com/ - ".{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceType"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "serviceID"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalService

-
-
-
-
Description
-

A configured external service.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The external service's unique ID.
- - kind - {" "} - -{" "} - - - ExternalServiceKind! - - - The kind of external service.
- - displayName - {" "} - -{" "} - - - String! - - - The display name of the external service.
- - config - {" "} - -{" "} - - - JSONCString! - - - - {" "} - The JSON configuration of the external service.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - When the external service was created.
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - When the external service was last updated.
- - repoCount - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repos synced by the external service.{" "} -
- - webhookURL - {" "} - -{" "} - - - String - - - - {" "} - An optional URL that will be populated when webhooks - have been configured for the external service.{" "} -
- - warning - {" "} - -{" "} - - - String - - - - {" "} - This is an optional field that's populated when we ran - into errors on the backend side when trying to - create/update an ExternalService, but the - create/update still succeeded. It is a field on - ExternalService instead of a separate thing in order - to not break the API and stay backwards compatible.{" "} -
- - lastSyncError - {" "} - -{" "} - - - String - - - - {" "} - External services are synced with code hosts in the - background. This optional field will contain any - errors that occurred during the most recent completed - sync.{" "} -
- - lastSyncAt - {" "} - -{" "} - - - DateTime - - - - {" "} - LastSyncAt is the time the last sync job was run for - this code host. Null if it has never been synced so - far.{" "} -
- - nextSyncAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The timestamp of the next sync job. Null if not - scheduled for a re-sync.{" "} -
- - webhookLogs - {" "} - -{" "} - - - WebhookLogConnection! - - - -

- Returns recently received webhooks on this external - service. -

-

Only site admins may access this field.

-

- DEPRECATED: Webhook logs linked directly to an - external service will be removed. See{" "} - - https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice - -

- - Webhook logs linked directly to an external service - will be removed. See{" "} - - https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice - - -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n webhook logs.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - onlyErrors - {" "} - -{" "} - - - Boolean - - -
-

- Only include webhook logs that resulted in - errors. -

-
-
-
- - since - {" "} - -{" "} - - - DateTime - - -
-

- Only include webhook logs on or after this - time. -

-
-
-
- - until - {" "} - -{" "} - - - DateTime - - -
-

- Only include webhook logs on or before this - time. -

-
-
-
-
- - syncJobs - {" "} - -{" "} - - - ExternalServiceSyncJobConnection! - - - - {" "} - The list of recent sync jobs for this external - service.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-
-
-
-
- - checkConnection - {" "} - -{" "} - - - ExternalServiceAvailability! - - - - {" "} - Checks the availability of the external service.{" "} -
- - hasConnectionCheck - {" "} - -{" "} - - - Boolean! - - - -

- True if this external service can perform - availability check by running checkConnection. -

-

- If this is false, then checkConnection responds with - ExternalServiceAvailabilityUnknown. -

-
- - supportsRepoExclusion - {" "} - -{" "} - - - Boolean! - - - - {" "} - True if this external service configuration supports{" "} - exclude parameter.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "kind"
-                                  :{" "}
-                                  "AWSCODECOMMIT"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "config"
-                                  :{" "}
-                                  JSONCString
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "createdAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "updatedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repoCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "webhookURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "warning"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastSyncError"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lastSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "nextSyncAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "webhookLogs"
-                                  :{" "}
-                                  WebhookLogConnection
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "syncJobs"
-                                  :{" "}
-                                  
-                                    ExternalServiceSyncJobConnection
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "checkConnection"
-                                  :{" "}
-                                  
-                                    ExternalServiceAvailable
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hasConnectionCheck"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "supportsRepoExclusion"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceAvailability

-
-
-
-
Description
-

- Availability status of an external service for diagnostic - purposes. -

-

- This is so that the UI can surface whether the external - service can serve requests, and if not, why is the reason - for that. -

-
-
-
Types
- - - - - - - - - - - - - - - - - -
Union Types
-

- - ExternalServiceAvailable - -

-
-

- - ExternalServiceUnavailable - -

-
-

- - ExternalServiceAvailabilityUnknown - -

-
-
-
-
-
-
Example
- 
-                                
-                                  
-                                    ExternalServiceAvailable
-                                  
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- ExternalServiceAvailabilityUnknown -

-
-
-
-
Description
-

- Availability for some external services may not be - determined, or only partially supported. In that case - unknown variant of ExternalServiceAvailability is returned. -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - implementationNote - {" "} - -{" "} - - - String! - - - - {" "} - User-friendly textual description of the - implementation status of availability. This is - expected to be tied to specific kinds of external - services.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "implementationNote"
-                                  :{" "}
-                                  "xyz789"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceAvailable

-
-
-
-
Description
-

- Indicator that the external service was recently found to be - available. -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - lastCheckedAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The timestamp of the last successful availability - check that was performed.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "lastCheckedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceConnection

-
-
-
-
Description
-

A list of external services.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExternalService!]! - - - A list of external services.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of external services in the - connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  ExternalService
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceKind

-
-
-
-
Description
-

A specific kind of external service.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- AWSCODECOMMIT -

-
-

- AZUREDEVOPS -

-
-

- BITBUCKETCLOUD -

-
-

- BITBUCKETSERVER -

-
-

- GERRIT -

-
-

- GITHUB -

-
-

- GITLAB -

-
-

- GITOLITE -

-
-

- GOMODULES -

-
-

- JVMPACKAGES -

-
-

- NPMPACKAGES -

-
-

- OTHER -

-
-

- PAGURE -

-
-

- PERFORCE -

-
-

- PHABRICATOR -

-
-

- PYTHONPACKAGES -

-
-

- RUSTPACKAGES -

-
-

- RUBYPACKAGES -

-
-
-
-
-
-
Example
- 
-                                
-                                  "AWSCODECOMMIT"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceNamespace

-
-
-
-
Description
-

- A namespace sourced from a defined external service (such as - GitHub, GitLab, Phabricator, etc.) that can be discovered - before any sync or mirror operations. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - The unique identifier of the external service - namespace.{" "} -
- - name - {" "} - -{" "} - - - String! - - - The name of the external service namespace.
- - externalID - {" "} - -{" "} - - - String! - - - - {" "} - The Namespace's ID on the external service. Example: - For GitHub, this is the GitHub GraphQL API's node ID - for the organization.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalID"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- ExternalServiceNamespaceConnection -

-
-
-
-
Description
-

- A list of namespaces available to an external service - configuration. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExternalServiceNamespace!]! - - - - {" "} - A list of namespaces available on the source. - Namespaces are used to organize which members and - users can access repositories and are defined by - external service kind (e.g. Github organizations, - Bitbucket projects, etc.){" "} -
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of source repos in the connection.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  
-                                    ExternalServiceNamespace
-                                  
-                                  ]
-                                  ,{" "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceSyncError

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: A status message produced when - repositories could not be synced from an external service -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - message - {" "} - -{" "} - - - String! - - - The message of this status message
- - externalService - {" "} - -{" "} - - - ExternalService! - - - The external service that failed to sync
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "message"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalService"
-                                  :{" "}
-                                  ExternalService
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceSyncJob

-
-
-
-
Description
-

- An external service sync job represents one sync with the - code host. It's a background job that will eventually be run - by the repo syncer. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique identifier of the sync job.
- - state - {" "} - -{" "} - - - ExternalServiceSyncJobState! - - - The current state of the sync job.
- - queuedAt - {" "} - -{" "} - - - DateTime! - - - When the sync job was added to the queue.
- - startedAt - {" "} - -{" "} - - - DateTime - - - Set when sync begins.
- - finishedAt - {" "} - -{" "} - - - DateTime - - - Set when sync finished.
- - failureMessage - {" "} - -{" "} - - - String - - - Error message, if the sync failed.
- - reposSynced - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repos synced during this sync job.{" "} -
- - repoSyncErrors - {" "} - -{" "} - - - Int! - - - - {" "} - The number of times an error occurred syncing a repo - during this sync job.{" "} -
- - reposAdded - {" "} - -{" "} - - - Int! - - - - {" "} - The number of new repos discovered during this sync - job.{" "} -
- - reposDeleted - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repos deleted as a result of this sync - job.{" "} -
- - reposModified - {" "} - -{" "} - - - Int! - - - - {" "} - The number of existing repos whose metadata has - changed during this sync job.{" "} -
- - reposUnmodified - {" "} - -{" "} - - - Int! - - - - {" "} - The number of existing repos whose metadata did not - change during this sync job.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "state"
-                                  :{" "}
-                                  "QUEUED"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "queuedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "startedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "finishedAt"
-                                  :{" "}
-                                  
-                                    "2007-12-03T10:15:30Z"
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "failureMessage"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "reposSynced"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repoSyncErrors"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "reposAdded"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "reposDeleted"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "reposModified"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "reposUnmodified"
-                                  :{" "}
-                                  123
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

- ExternalServiceSyncJobConnection -

-
-
-
-
Description
-

A list of external service sync jobs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [ExternalServiceSyncJob!]! - - - A list of sync jobs.
- - totalCount - {" "} - -{" "} - - - Int! - - - The total number of jobs in the connection.
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  
-                                    ExternalServiceSyncJob
-                                  
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceSyncJobState

-
-
-
-
Description
-

The possible states of an external service sync job.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- QUEUED -

- 		- {" "} - Not yet started. Will be picked up by a worker - eventually.{" "} -
-

- PROCESSING -

- 		Currently syncing.
-

- ERRORED -

- 		- {" "} - An error occurred while syncing. Will be retried - eventually.{" "} -
-

- FAILED -

- 		- {" "} - A fatal error occurred while syncing. No retries will - be made.{" "} -
-

- COMPLETED -

- 		Sync finished successfully.
-

- CANCELING -

- 		Sync job is being canceled.
-

- CANCELED -

- 		Sync job has been canceled.
-
-
-
-
-
Example
- 
-                                
-                                  "QUEUED"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

ExternalServiceUnavailable

-
-
-
-
Description
-

- Indicator that the external service was recently not found - available. -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - suspectedReason - {" "} - -{" "} - - - String! - - - - {" "} - User-friendly textual description of supposed reason - why the service is not available.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "suspectedReason"
-                                  :{" "}
-                                  "abc123"
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FeatureFlag

-
-
-
-
Description
-

- A feature flag is either a static boolean feature flag or a - rollout feature flag -

-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- - FeatureFlagBoolean - -

-
-

- - FeatureFlagRollout - -

-
-
-
-
-
-
Example
- 
-                                
-                                  FeatureFlagBoolean
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FeatureFlagBoolean

-
-
-
-
Description
-

A feature flag that has a statically configured value

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
- - value - {" "} - -{" "} - - - Boolean! - - - The static value of the feature flag
- - overrides - {" "} - -{" "} - - - [FeatureFlagOverride!]! - - - Overrides that apply to the feature flag
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "overrides"
-                                  :{" "}
-                                  [
-                                  FeatureFlagOverride
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FeatureFlagOverride

-
-
-
-
Description
-

- A feature flag override is an override of a feature flag's - value for a specific org or user -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - A unique ID for this feature flag override
- - namespace - {" "} - -{" "} - - - Namespace! - - - - {" "} - The namespace for this override. Will always be a user - or org.{" "} -
- - targetFlag - {" "} - -{" "} - - - FeatureFlag! - - - The name of the feature flag being overridden
- - value - {" "} - -{" "} - - - Boolean! - - - The overridden value of the feature flag
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "namespace"
-                                  :{" "}
-                                  Namespace
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "targetFlag"
-                                  :{" "}
-                                  FeatureFlagBoolean
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "value"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FeatureFlagRollout

-
-
-
-
Description
-

- A feature flag that is randomly evaluated to a boolean based - on the rollout parameter -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the feature flag
- - rolloutBasisPoints - {" "} - -{" "} - - - Int! - - - - {" "} - The ratio of users that will be assigned this this - feature flag, expressed in basis points (0.01%).{" "} -
- - overrides - {" "} - -{" "} - - - [FeatureFlagOverride!]! - - - Overrides that apply to the feature flag
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "rolloutBasisPoints"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "overrides"
-                                  :{" "}
-                                  [
-                                  FeatureFlagOverride
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

File

-
-
-
-
Description
-

- File is temporarily preserved for backcompat with browser - extension search API client code. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the repository root) of - this file.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., file name only) of this file's - path.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - Whether this is a directory.
- - url - {" "} - -{" "} - - - String! - - - The URL to this file on Sourcegraph.
- - repository - {" "} - -{" "} - - - Repository! - - - The repository that contains this file.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "path"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isDirectory"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

File2

-
-
-
-
Description
-

- A file. In a future version of Sourcegraph, a repository's - files may be distinct from a repository's blobs (for - example, to support searching/browsing generated files that - aren't committed and don't exist as Git blobs). Clients - should generally use the GitBlob concrete type and - GitCommit.blobs (not GitCommit.files), unless they - explicitly want to opt-in to different behavior in the - future. INTERNAL: This is temporarily named File2 during a - migration. Do not refer to the name File2 in any API clients - as the name will change soon. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the root) of this file.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., file name only) of this file.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - - {" "} - False because this is a file, not a directory.{" "} -
- - content - {" "} - -{" "} - - - String! - - - The content of this file.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return file content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return file content ending at line "endLine". - A value < 0 or > totalLines will set - endLine to the end of the file. -

-
-
-
-
- - byteSize - {" "} - -{" "} - - - Int! - - - The file size in bytes.
- - totalLines - {" "} - -{" "} - - - Int! - - - - {" "} - Total line count for the file. Returns 0 for binary - files.{" "} -
- - binary - {" "} - -{" "} - - - Boolean! - - - Whether or not it is binary.
- - richHTML - {" "} - -{" "} - - - String! - - - - {" "} - The file rendered as rich HTML, or an empty string if - it is not a supported rich file type. This HTML string - is already escaped and thus is always safe to render.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. -

-
-
-
-
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this file (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this file (using an immutable - revision specifier).{" "} -
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - The URLs to this file on external services.
- - highlight - {" "} - -{" "} - - - HighlightedFile! - - - Highlight the file.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - disableTimeout - {" "} - -{" "} - - - Boolean! - - -
-
-
-
- - highlightLongLines - {" "} - -{" "} - - - Boolean - - -
-

- If highlightLongLines is true, lines which are - longer than 2000 bytes are highlighted. 2000 - bytes is enabled. This may produce a - significant amount of HTML which some browsers - (such as Chrome, but not Firefox) may have - trouble rendering efficiently. -

-
-
-
- - format - {" "} - -{" "} - - - HighlightResponseFormat - - -
-

- Specifies which format/highlighting technique - to use. -

-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return highlight content starting at line - "startLine". A value <= 0 will be the start - of the file. Warning: Pagination only works - with the HTML_PLAINTEXT format type at the - moment. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return blob highlight ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. - Warning: Pagination only works with the - HTML_PLAINTEXT format type at the moment. -

-
-
-
-
-
-
-
Possible Types
- - - - - - - - - - - - - - -
File2 Types
-

- - VirtualFile - -

-
-

- - GitBlob - -

-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "path"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isDirectory"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "content"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "byteSize"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalLines"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "binary"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "richHTML"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "canonicalURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalURLs"
-                                  :{" "}
-                                  [
-                                  ExternalLink
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "highlight"
-                                  :{" "}
-                                  HighlightedFile
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FileDiff

-
-
-
-
Description
-

A diff for a single file.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - oldPath - {" "} - -{" "} - - - String - - - - {" "} - The old (original) path of the file, or null if the - file was added.{" "} -
- - oldFile - {" "} - -{" "} - - - File2 - - - - {" "} - The old file, or null if the file was created - (oldFile.path == oldPath).{" "} -
- - newPath - {" "} - -{" "} - - - String - - - - {" "} - The new (changed) path of the file, or null if the - file was deleted.{" "} -
- - newFile - {" "} - -{" "} - - - File2 - - - - {" "} - The new file, or null if the file was deleted - (newFile.path == newPath).{" "} -
- - mostRelevantFile - {" "} - -{" "} - - - File2! - - - - {" "} - The old file (if the file was deleted) and otherwise - the new file. This file field is typically used by - clients that want to show a "View" link to the file.{" "} -
- - hunks - {" "} - -{" "} - - - [FileDiffHunk!]! - - - Hunks that were changed from old to new.
- - stat - {" "} - -{" "} - - - DiffStat! - - - The diff stat for the whole file.
- - internalID - {" "} - -{" "} - - - String! - - - - {" "} - FOR INTERNAL USE ONLY. An identifier for the file diff - that is unique among all other file diffs in the list - that contains it.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "oldPath"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "oldFile"
-                                  :{" "}
-                                  File2
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "newPath"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "newFile"
-                                  :{" "}
-                                  File2
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "mostRelevantFile"
-                                  :{" "}
-                                  File2
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "hunks"
-                                  :{" "}
-                                  [
-                                  FileDiffHunk
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "stat"
-                                  :{" "}
-                                  DiffStat
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "internalID"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FileDiffConnection

-
-
-
-
Description
-

A list of file diffs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [FileDiff!]! - - - A list of file diffs.
- - totalCount - {" "} - -{" "} - - - Int - - - - {" "} - The total count of file diffs in the connection, if - available. This total count may be larger than the - number of nodes in this object when the result is - paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
- - diffStat - {" "} - -{" "} - - - DiffStat! - - - - {" "} - The diff stat for the file diffs in this object, which - may be a subset of the entire diff if the result is - paginated.{" "} -
- - rawDiff - {" "} - -{" "} - - - String! - - - - {" "} - The raw diff for the file diffs in this object, which - may be a subset of the entire diff if the result is - paginated.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  FileDiff
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  987
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "diffStat"
-                                  :{" "}
-                                  DiffStat
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "rawDiff"
-                                  :{" "}
-                                  "abc123"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FileDiffHunk

-
-
-
-
Description
-

A changed region ("hunk") in a file diff.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - oldRange - {" "} - -{" "} - - - FileDiffHunkRange! - - - - {" "} - The range of the old file that the hunk applies to.{" "} -
- - oldNoNewlineAt - {" "} - -{" "} - - - Boolean! - - - Whether the old file had a trailing newline.
- - newRange - {" "} - -{" "} - - - FileDiffHunkRange! - - - - {" "} - The range of the new file that the hunk applies to.{" "} -
- - section - {" "} - -{" "} - - - String - - - The diff hunk section heading, if any.
- - body - {" "} - -{" "} - - - String! - - - - {" "} - The hunk body, with lines prefixed with '-', '+', or ' - '.{" "} -
- - highlight - {" "} - -{" "} - - - HighlightedDiffHunkBody! - - - Highlight the hunk.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - disableTimeout - {" "} - -{" "} - - - Boolean! - - -
-
-
-
- - highlightLongLines - {" "} - -{" "} - - - Boolean - - -
-

- If highlightLongLines is true, lines which are - longer than 2000 bytes are highlighted. 2000 - bytes is enabled. This may produce a - significant amount of HTML which some browsers - (such as Chrome, but not Firefox) may have - trouble rendering efficiently. -

-
-
-
- - format - {" "} - -{" "} - - - HighlightResponseFormat - - -
-

- Specifies which format/highlighting technique - to use. -

-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "oldRange"
-                                  :{" "}
-                                  FileDiffHunkRange
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "oldNoNewlineAt"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "newRange"
-                                  :{" "}
-                                  FileDiffHunkRange
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "section"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "body"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "highlight"
-                                  :{" "}
-                                  
-                                    HighlightedDiffHunkBody
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FileDiffHunkRange

-
-
-
-
Description
-

A hunk range in one side (old/new) of a diff.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - startLine - {" "} - -{" "} - - - Int! - - - The first line that the hunk applies to.
- - lines - {" "} - -{" "} - - - Int! - - - The number of lines that the hunk applies to.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  "startLine"
-                                  :{" "}
-                                  987
-                                  ,{" "}
-                                  "lines"
-                                  :{" "}
-                                  987
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

FileMatch

-
-
-
-
Description
-

A file match.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - file - {" "} - -{" "} - - - GitBlob! - - - - {" "} - The file containing the match. KNOWN ISSUE: This - file's "commit" field contains incomplete data. KNOWN - ISSUE: This field's type should be File! not GitBlob!.{" "} -
- - repository - {" "} - -{" "} - - - Repository! - - - The repository containing the file match.
- - revSpec - {" "} - -{" "} - - - GitRevSpec - - - - {" "} - The revspec of the revision that contains this match. - If no revspec was given (such as when no repository - filter or revspec is specified in the search query), - it is null.{" "} -
- - symbols - {" "} - -{" "} - - - [Symbol!]! - - - - {" "} - The symbols found in this file that match the query.{" "} -
- - lineMatches - {" "} - -{" "} - - - [LineMatch!]! - - - The line matches.
- - chunkMatches - {" "} - -{" "} - - - [ChunkMatch!]! - - - - {" "} - EXPERIMENTAL: This field is experimental and may be - unstable. The chunk matches.{" "} -
- - limitHit - {" "} - -{" "} - - - Boolean! - - - Whether or not the limit was hit.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "file"
-                                  :{" "}
-                                  GitBlob
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "revSpec"
-                                  :{" "}
-                                  GitRef
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "symbols"
-                                  :{" "}
-                                  [
-                                  Symbol
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lineMatches"
-                                  :{" "}
-                                  [
-                                  LineMatch
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "chunkMatches"
-                                  :{" "}
-                                  [
-                                  ChunkMatch
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "limitHit"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

Float

-
-
-
-
Description
-

- The Float scalar type represents signed - double-precision fractional values as specified by{" "} - - IEEE 754 - - . -

-
-
-
-
-
Example
- 
-                                
-                                  987.65
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GenericSearchResultInterface

-
-
-
-
Description
-

- A search result. Every type of search result, except - FileMatch, must implement this interface. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - label - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string that is rendered prominently.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL of the result.
- - detail - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string that is rendered less prominently.{" "} -
- - matches - {" "} - -{" "} - - - [SearchResultMatch!]! - - - A list of matches in this search result.
-
-
-
Possible Types
- - - - - - - - - - - - - - -
GenericSearchResultInterface Types
-

- - CommitSearchResult - -

-
-

- - Repository - -

-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "label"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "detail"
-                                  :{" "}
-                                  Markdown
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "matches"
-                                  :{" "}
-                                  [
-                                  SearchResultMatch
-                                  ]
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitBlob

-
-
-
-
Description
-

A Git blob in a repository.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the repository root) of - this blob.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., file name only) of this blob's - path.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - - {" "} - False because this is a blob (file), not a directory.{" "} -
- - content - {" "} - -{" "} - - - String! - - - The content of this blob.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return blob content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return blob content ending at line "endLine". - A value < 0 or > totalLines will set - endLine to the end of the file. -

-
-
-
-
- - byteSize - {" "} - -{" "} - - - Int! - - - The file size in bytes.
- - totalLines - {" "} - -{" "} - - - Int! - - - - {" "} - Total line count for the Blob. Returns 0 for binary - files.{" "} -
- - binary - {" "} - -{" "} - - - Boolean! - - - Whether or not it is binary.
- - richHTML - {" "} - -{" "} - - - String! - - - - {" "} - The blob contents rendered as rich HTML, or an empty - string if it is not a supported rich file type. This - HTML string is already escaped and thus is always safe - to render.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. -

-
-
-
-
- - commit - {" "} - -{" "} - - - GitCommit! - - - The Git commit containing this blob.
- - repository - {" "} - -{" "} - - - Repository! - - - The repository containing this Git blob.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this blob (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this blob (using an immutable - revision specifier).{" "} -
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - - {" "} - The URLs to this blob on its repository's external - services.{" "} -
- - blame - {" "} - -{" "} - - - [Hunk!]! - - - Blame the blob.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int! - - -
-
-
-
- - endLine - {" "} - -{" "} - - - Int! - - -
-
-
-
-
- - highlight - {" "} - -{" "} - - - HighlightedFile! - - - Highlight the blob contents.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - disableTimeout - {" "} - -{" "} - - - Boolean! - - -
-
-
-
- - highlightLongLines - {" "} - -{" "} - - - Boolean - - -
-

- If highlightLongLines is true, lines which are - longer than 2000 bytes are highlighted. 2000 - bytes is enabled. This may produce a - significant amount of HTML which some browsers - (such as Chrome, but not Firefox) may have - trouble rendering efficiently. -

-
-
-
- - format - {" "} - -{" "} - - - HighlightResponseFormat - - -
-

- Specifies which format/highlighting technique - to use. -

-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return highlight content starting at line - "startLine". A value <= 0 will be the start - of the file. Warning: Pagination only works - with the HTML_PLAINTEXT format type at the - moment. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return highlight content ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. - Warning: Pagination only works with the - HTML_PLAINTEXT format type at the moment. -

-
-
-
-
- - submodule - {" "} - -{" "} - - - Submodule - - - - {" "} - Submodule metadata if this tree points to a submodule{" "} -
- - symbols - {" "} - -{" "} - - - SymbolConnection! - - - Symbols defined in this blob.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n symbols from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

Return symbols matching the query.

-
-
-
-
- - symbol - {" "} - -{" "} - - - Symbol - - - - {" "} - (Experimental) Symbol defined in this blob at the - specific line number and character offset.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - line - {" "} - -{" "} - - - Int! - - -
-

The line number (0-based).

-
-
-
- - character - {" "} - -{" "} - - - Int! - - -
-

- The character offset (0-based). The offset is - measured in characters, not bytes. -

-
-
-
-
- - isSingleChild - {" "} - -{" "} - - - Boolean! - - - - {" "} - Always false, since a blob is a file, not directory.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

Recurse into sub-trees.

-
-
-
- - recursiveSingleChild - {" "} - -{" "} - - - Boolean - - -
-

- Recurse into sub-trees of single-child - directories -

-
-
-
-
- - lfs - {" "} - -{" "} - - - LFS - - - - {" "} - LFS is set if the GitBlob is a pointer to a file - stored in LFS.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "path"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isDirectory"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "content"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "byteSize"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalLines"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "binary"
-                                  :{" "}
-                                  
-                                    true
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "richHTML"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "commit"
-                                  :{" "}
-                                  GitCommit
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "canonicalURL"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalURLs"
-                                  :{" "}
-                                  [
-                                  ExternalLink
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "blame"
-                                  :{" "}
-                                  [
-                                  Hunk
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "highlight"
-                                  :{" "}
-                                  HighlightedFile
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "submodule"
-                                  :{" "}
-                                  Submodule
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "symbols"
-                                  :{" "}
-                                  SymbolConnection
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "symbol"
-                                  :{" "}
-                                  Symbol
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "isSingleChild"
-                                  :{" "}
-                                  
-                                    false
-                                  
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "lfs"
-                                  :{" "}
-                                  LFS
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitCommit

-
-
-
-
Description
-

A Git commit.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The globally addressable ID for this commit.
- - repository - {" "} - -{" "} - - - Repository! - - - The repository that contains this commit.
- - oid - {" "} - -{" "} - - - GitObjectID! - - - - {" "} - This commit's Git object ID (OID), a 40-character - SHA-1 hash.{" "} -
- - abbreviatedOID - {" "} - -{" "} - - - String! - - - The abbreviated form of this commit's OID.
- - author - {" "} - -{" "} - - - Signature! - - - This commit's author.
- - committer - {" "} - -{" "} - - - Signature - - - This commit's committer, if any.
- - message - {" "} - -{" "} - - - String! - - - The full commit message.
- - subject - {" "} - -{" "} - - - String! - - - The first line of the commit message.
- - body - {" "} - -{" "} - - - String - - - - {" "} - The contents of the commit message after the first - line.{" "} -
- - parents - {" "} - -{" "} - - - [GitCommit!]! - - - Parent commits of this commit.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this commit (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this commit (using an immutable - revision specifier).{" "} -
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - - {" "} - The URLs to this commit on its repository's external - services.{" "} -
- - path - {" "} - -{" "} - - - GitTreeOrBlob - - - - {" "} - The Git tree or blob in this commit at the given path.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - path - {" "} - -{" "} - - - String - - -
-

The path of the tree or blob.

-
-
-
-
- - tree - {" "} - -{" "} - - - GitTree - - - - {" "} - The Git tree in this commit at the given path.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - path - {" "} - -{" "} - - - String - - -
-

The path of the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

- Whether to recurse into sub-trees. If true, it - overrides the value of the "recursive" - parameter on all of GitTree's fields. - DEPRECATED: Use the "recursive" parameter on - GitTree's fields instead. -

-
-
-
-
- - fileNames - {" "} - -{" "} - - - [String!]! - - - A list of file names in this repository.
- - blob - {" "} - -{" "} - - - GitBlob - - - - {" "} - The Git blob in this commit at the given path.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - path - {" "} - -{" "} - - - String! - - -
-
-
-
-
- - file - {" "} - -{" "} - - - File2 - - - - {" "} - The file at the given path for this commit. See "File" - documentation for the difference between this field - and the "blob" field.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - path - {" "} - -{" "} - - - String! - - -
-
-
-
-
- - languages - {" "} - -{" "} - - - [String!]! - - - - {" "} - Lists the programming languages present in the tree at - this commit.{" "} -
- - languageStatistics - {" "} - -{" "} - - - [LanguageStatistics!]! - - - - {" "} - List statistics for each language present in the - repository.{" "} -
- - ancestors - {" "} - -{" "} - - - GitCommitConnection! - - - - {" "} - The log of commits consisting of this commit and its - ancestors.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n commits from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

Return commits that match the query.

-
-
-
- - path - {" "} - -{" "} - - - String - - -
-

Return commits that affect the path.

-
-
-
- - follow - {" "} - -{" "} - - - Boolean - - -
-

- Follow history beyond renames (only works for - a single file). -

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

- Return commits more recent than the specified - date. -

-
-
-
- - afterCursor - {" "} - -{" "} - - - String - - -
-

- Skip the first N commits of the repo before - returning the number of commits as set in the - field "first". -

-
-
-
- - before - {" "} - -{" "} - - - String - - -
-

- Return commits older than the specified date. -

-
-
-
-
- - behindAhead - {" "} - -{" "} - - - BehindAheadCounts! - - - - {" "} - Returns the number of commits that this commit is - behind and ahead of revspec.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - revspec - {" "} - -{" "} - - - String! - - -
-
-
-
-
- - symbols - {" "} - -{" "} - - - SymbolConnection! - - - - {" "} - Symbols defined as of this commit. (All symbols, not - just symbols that were newly defined in this commit.){" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n symbols from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

Return symbols matching the query.

-
-
-
- - includePatterns - {" "} - -{" "} - - - [String!] - - -
-

- A list of regular expressions, all of which - must match all file paths returned in the - list. -

-
-
-
-
- - diff - {" "} - -{" "} - - - RepositoryComparison! - - - Returns the comparison with another revision.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - base - {" "} - -{" "} - - - String - - -
-

- The base commit to compare to. Defaults to the - commit's first parent. -

-
-
-
-
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  4
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "oid"
-                                  :{" "}
-                                  GitObjectID
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "abbreviatedOID"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "author"
-                                  :{" "}
-                                  Signature
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "committer"
-                                  :{" "}
-                                  Signature
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "message"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "subject"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "body"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "parents"
-                                  :{" "}
-                                  [
-                                  GitCommit
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "canonicalURL"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "externalURLs"
-                                  :{" "}
-                                  [
-                                  ExternalLink
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "path"
-                                  :{" "}
-                                  GitTree
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "tree"
-                                  :{" "}
-                                  GitTree
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "fileNames"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "blob"
-                                  :{" "}
-                                  GitBlob
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "file"
-                                  :{" "}
-                                  File2
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "languages"
-                                  :{" "}
-                                  [
-                                  "abc123"
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "languageStatistics"
-                                  :{" "}
-                                  [
-                                  LanguageStatistics
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "ancestors"
-                                  :{" "}
-                                  GitCommitConnection
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "behindAhead"
-                                  :{" "}
-                                  BehindAheadCounts
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "symbols"
-                                  :{" "}
-                                  SymbolConnection
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "diff"
-                                  :{" "}
-                                  RepositoryComparison
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitCommitConnection

-
-
-
-
Description
-

A list of Git commits.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [GitCommit!]! - - - A list of Git commits.
- - totalCount - {" "} - -{" "} - - - Int - - - - {" "} - The total number of Git commits in the connection. If - the GitCommitConnection is paginated (e.g., because a - "first" parameter was provided to the field that - produced it), this field is null to avoid it taking - unexpectedly long to compute the total count. Remove - the pagination parameters to obtain a non-null value - for this field.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  GitCommit
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitObject

-
-
-
-
Description
-

A Git object.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - oid - {" "} - -{" "} - - - GitObjectID! - - - This object's OID.
- - abbreviatedOID - {" "} - -{" "} - - - String! - - - The abbreviated form of this object's OID.
- - commit - {" "} - -{" "} - - - GitCommit - - - - {" "} - The commit object, if it is a commit and it exists; - otherwise null.{" "} -
- - type - {" "} - -{" "} - - - GitObjectType! - - - The Git object's type.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "oid"
-                                  :{" "}
-                                  GitObjectID
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "abbreviatedOID"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "commit"
-                                  :{" "}
-                                  GitCommit
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "type"
-                                  :{" "}
-                                  "GIT_COMMIT"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitObjectID

-
-
-
-
Description
-

- A Git object ID (SHA-1 hash, 40 hexadecimal characters). -

-
-
-
-
-
Example
- 
-                                
-                                  GitObjectID
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitObjectType

-
-
-
-
Description
-

All possible types of Git objects.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- GIT_COMMIT -

- 		A Git commit object.
-

- GIT_TAG -

- 		A Git tag object.
-

- GIT_TREE -

- 		A Git tree object.
-

- GIT_BLOB -

- 		A Git blob object.
-

- GIT_UNKNOWN -

- 		A Git object of unknown type.
-
-
-
-
-
Example
- 
-                                
-                                  "GIT_COMMIT"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRef

-
-
-
-
Description
-

A Git ref.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The globally addressable ID for the Git ref.
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The full ref name (e.g., "refs/heads/mybranch" or - "refs/tags/mytag").{" "} -
- - abbrevName - {" "} - -{" "} - - - String! - - - An unambiguous short name for the ref.
- - displayName - {" "} - -{" "} - - - String! - - - - {" "} - The display name of the ref. For branches - ("refs/heads/foo"), this is the branch name ("foo"). - As a special case, for GitHub pull request refs of the - form refs/pull/NUMBER/head, this is "NUMBER".{" "} -
- - prefix - {" "} - -{" "} - - - String! - - - - {" "} - The prefix of the ref, either "", "refs/", - "refs/heads/", "refs/pull/", or "refs/tags/". This - prefix is always a prefix of the ref's name.{" "} -
- - type - {" "} - -{" "} - - - GitRefType! - - - The type of this Git ref.
- - target - {" "} - -{" "} - - - GitObject! - - - The object that the ref points to.
- - repository - {" "} - -{" "} - - - Repository! - - - The associated repository.
- - url - {" "} - -{" "} - - - String! - - - The URL to this Git ref.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "id"
-                                  :{" "}
-                                  "4"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "name"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "abbrevName"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "displayName"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "prefix"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "type"
-                                  :{" "}
-                                  "GIT_BRANCH"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "target"
-                                  :{" "}
-                                  GitObject
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "repository"
-                                  :{" "}
-                                  Repository
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "url"
-                                  :{" "}
-                                  "xyz789"
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRefConnection

-
-
-
-
Description
-

A list of Git refs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [GitRef!]! - - - A list of Git refs.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of Git refs in the connection. This - total count may be larger than the number of nodes in - this object when the result is paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "nodes"
-                                  :{" "}
-                                  [
-                                  GitRef
-                                  ]
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "totalCount"
-                                  :{" "}
-                                  123
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "pageInfo"
-                                  :{" "}
-                                  PageInfo
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRefOrder

-
-
-
-
Description
-

Ordering options for Git refs.

-
-
-
Values
- - - - - - - - - - - - - -
Enum ValueDescription
-

- AUTHORED_OR_COMMITTED_AT -

- 		- {" "} - By the authored or committed at date, whichever is - more recent.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  
-                                    "AUTHORED_OR_COMMITTED_AT"
-                                  
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRefType

-
-
-
-
Description
-

All possible types of Git refs.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- GIT_BRANCH -

- 		A Git branch (in refs/heads/).
-

- GIT_TAG -

- 		A Git tag (in refs/tags/).
-

- GIT_REF_OTHER -

- 		A Git ref that is neither a branch nor tag.
-
-
-
-
-
Example
- 
-                                
-                                  "GIT_BRANCH"
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRevSpec

-
-
-
-
Description
-

A Git revspec.

-
-
-
Types
- - - - - - - - - - - - - - - - - -
Union Types
-

- - GitRef - -

-
-

- - GitRevSpecExpr - -

-
-

- - GitObject - -

-
-
-
-
-
-
Example
- 
-                                
-                                  GitRef
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRevSpecExpr

-
-
-
-
Description
-

- A Git revspec expression that (possibly) resolves to a Git - revision. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - expr - {" "} - -{" "} - - - String! - - - The original Git revspec expression.
- - object - {" "} - -{" "} - - - GitObject - - - - {" "} - The Git object that the revspec resolves to, or null - otherwise.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "expr"
-                                  :{" "}
-                                  "xyz789"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "object"
-                                  :{" "}
-                                  GitObject
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitRevisionRange

-
-
-
-
Description
-

- A Git revision range of the form "base..head" or - "base...head". Other revision range formats are not - supported. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - expr - {" "} - -{" "} - - - String! - - - - {" "} - The Git revision range expression of the form - "base..head" or "base...head".{" "} -
- - base - {" "} - -{" "} - - - GitRevSpec! - - - The base (left-hand side) of the range.
- - baseRevSpec - {" "} - -{" "} - - - GitRevSpecExpr! - - - The base's revspec as an expression.
- - head - {" "} - -{" "} - - - GitRevSpec! - - - The head (right-hand side) of the range.
- - headRevSpec - {" "} - -{" "} - - - GitRevSpecExpr! - - - The head's revspec as an expression.
- - mergeBase - {" "} - -{" "} - - - GitObject - - - - {" "} - The merge-base of the base and head revisions, if this - is a "base...head" revision range. If this is a - "base..head" revision range, then this field is null.{" "} -
-
-
-
-
-
Example
- 
-                                
-                                  {"{"}
-                                  {"\n"}
-                                  {"  "}
-                                  "expr"
-                                  :{" "}
-                                  "abc123"
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "base"
-                                  :{" "}
-                                  GitRef
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "baseRevSpec"
-                                  :{" "}
-                                  GitRevSpecExpr
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "head"
-                                  :{" "}
-                                  GitRef
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "headRevSpec"
-                                  :{" "}
-                                  GitRevSpecExpr
-                                  ,
-                                  {"\n"}
-                                  {"  "}
-                                  "mergeBase"
-                                  :{" "}
-                                  GitObject
-                                  {"\n"}
-                                  {"}"}
-                                  {"\n"}
-                                
-
-
-
-
-
-
-
- Types -
-

GitTree

-
-
-
-
Description
-

A Git tree in a repository.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the root) of this tree.{" "} -
- - isRoot - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether this tree is the root (top-level) tree.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., last path component only) of this - tree.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - - {" "} - True because this is a directory. (The value differs - for other TreeEntry interface implementations, such as - File.){" "} -
- - commit - {" "} - -{" "} - - - GitCommit! - - - The Git commit containing this tree.
- - repository - {" "} - -{" "} - - - Repository! - - - The repository containing this tree.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this tree (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this tree (using an immutable - revision specifier).{" "} -
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - The URLs to this tree on external services.
- - rawZipArchiveURL - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this entry's raw contents as a Zip archive.{" "} -
- - submodule - {" "} - -{" "} - - - Submodule - - - - {" "} - Submodule metadata if this tree points to a submodule{" "} -
- - directories - {" "} - -{" "} - - - [GitTree!]! - - - A list of directories in this tree.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

Recurse into sub-trees.

-
-
-
-
- - files - {" "} - -{" "} - - - [File!]! - - - A list of files in this tree.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

Recurse into sub-trees.

-
-
-
-
- - entries - {" "} - -{" "} - - - [TreeEntry!]! - - - A list of entries in this tree.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

- Recurse into sub-trees. If true, implies - recursiveSingleChild. -

-
-
-
- - recursiveSingleChild - {" "} - -{" "} - - - Boolean - - -
-

- Recurse into sub-trees of single-child - directories. If true, we return a flat list of - every directory that is a single child, and - any directories or files that are nested in a - single child. -

-
-
-
- - ancestors - {" "} - -{" "} - - - Boolean - - -
-

- Includes all parent directories and their - entries. For example, if the path is{" "} - /client/web/something, it will - return the following entries in this order: -

-
    -
  • - {/* If you want to render the text /* in JSX without it being treated as a comment, please use {'/*'}. */} - {'/*'} -
    • -
  • - /client/* -
    • -
  • - /client/web/* -
    • -
  • - /client/web/something/* -
    • -
-

- This is useful for rendering a collapsed tree - view for the entry. -

-
-
-
-
- - symbols - {" "} - -{" "} - - - SymbolConnection! - - - Symbols defined in this tree.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n symbols from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

Return symbols matching the query.

-
-
-
-
- - isSingleChild - {" "} - -{" "} - - - Boolean! - - - Whether this tree entry is a single child
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

Recurse into sub-trees.

-
-
-
- - recursiveSingleChild - {" "} - -{" "} - - - Boolean - - -
-

- Recurse into sub-trees of single-child - directories -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "path"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isRoot"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isDirectory"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commit"
-                      :{" "}
-                      GitCommit
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canonicalURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalURLs"
-                      :{" "}
-                      [
-                      ExternalLink
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "rawZipArchiveURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "submodule"
-                      :{" "}
-                      Submodule
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "directories"
-                      :{" "}
-                      [
-                      GitTree
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "files"
-                      :{" "}
-                      [
-                      File
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "entries"
-                      :{" "}
-                      [
-                      TreeEntry
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "symbols"
-                      :{" "}
-                      SymbolConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isSingleChild"
-                      :{" "}
-                      
-                        true
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

GitTreeOrBlob

-
-
-
-
Description
-

Either a git tree or blob.

-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- - GitTree - -

-
-

- - GitBlob - -

-
-
-
-
-
-
Example
- 
-                    
-                      GitTree
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

GitUpdatesDisabled

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: A status message produced when - disableAutoGitUpdates is set to true in the site - configuration -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - message - {" "} - -{" "} - - - String! - - - The message of this status message
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "message"
-                      :{" "}
-                      "xyz789"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HTTPHeader

-
-
-
-
Description
-

A key-value pair

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The header name
- - values - {" "} - -{" "} - - - [String!]! - - - Can be multiple values
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "values"
-                      :{" "}
-                      [
-                      "xyz789"
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- HappinessFeedbackSubmissionInput -

-
-
-
-
Description
-

Input for a happiness feedback submission.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- - feedback - {" "} - -{" "} - - - String - - - The feedback text from the user.
- - currentPath - {" "} - -{" "} - - - String - - - - {" "} - The path that the happiness feedback will be submitted - from.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "feedback"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "currentPath"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Highlight

-
-
-
-
Description
-

- A highlighted region in a string (e.g., matched by a query). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - line - {" "} - -{" "} - - - Int! - - - The 1-indexed line number.
- - character - {" "} - -{" "} - - - Int! - - - The 1-indexed character on the line.
- - length - {" "} - -{" "} - - - Int! - - - - {" "} - The length of the highlight, in characters (on the - same line).{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "line"
-                      :{" "}
-                      123
-                      ,{" "}
-                      "character"
-                      :{" "}
-                      987
-                      ,{" "}
-                      "length"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightLineRange

-
-
-
-
Description
-

A specific highlighted line range to fetch.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- - startLine - {" "} - -{" "} - - - Int! - - - - {" "} - The first line to fetch (0-indexed, inclusive). Values - outside the bounds of the file will automatically be - clamped within the valid range.{" "} -
- - endLine - {" "} - -{" "} - - - Int! - - - - {" "} - The last line to fetch (0-indexed, inclusive). Values - outside the bounds of the file will automatically be - clamped within the valid range.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "startLine"
-                      :{" "}
-                      987
-                      ,{" "}
-                      "endLine"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightResponseFormat

-
-
-
-
Description
-

- The format and highlighting to use when requesting - highlighting information for a file. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- HTML_PLAINTEXT -

- 		- {" "} - HTML formatted file content without syntax - highlighting.{" "} -
-

- HTML_HIGHLIGHT -

- 		- {" "} - HTML formatted file content with syntax highlighting.{" "} -
-

- JSON_SCIP -

- 		SCIP highlighting information as JSON.
-
-
-
-
-
Example
- 
-                    
-                      "HTML_PLAINTEXT"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightedDiffHunkBody

-
-
-
-
Description
-

A highlighted hunk, consisting of all its lines.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - aborted - {" "} - -{" "} - - - Boolean! - - - Whether highlighting was aborted.
- - lines - {" "} - -{" "} - - - [HighlightedDiffHunkLine!]! - - - The highlighted lines.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "aborted"
-                      :{" "}
-                      
-                        true
-                      
-                      ,{" "}
-                      "lines"
-                      :{" "}
-                      [
-                      
-                        HighlightedDiffHunkLine
-                      
-                      ]
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightedDiffHunkLine

-
-
-
-
Description
-

A single highlighted line, including the kind of line.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - html - {" "} - -{" "} - - - String! - - - - {" "} - The HTML containing the syntax-highlighted line of - code.{" "} -
- - kind - {" "} - -{" "} - - - DiffHunkLineType! - - - - {" "} - The operation that happened on this line, in patches - it is prefixed with '+', '-', ' '. Can be either add, - delete, or no change.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "html"
-                      :{" "}
-                      "xyz789"
-                      ,{" "}
-                      "kind"
-                      :{" "}
-                      "ADDED"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightedFile

-
-
-
-
Description
-

A highlighted file.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - aborted - {" "} - -{" "} - - - Boolean! - - - Whether or not it was aborted.
- - html - {" "} - -{" "} - - - String! - - - - {" "} - The HTML table that can be used to display the - highlighted file.{" "} -
- - lsif - {" "} - -{" "} - - - String! - - - - {" "} - Base64 encoded JSON payload of LSIF Typed with syntax - highlighting data.{" "} -
- - lineRanges - {" "} - -{" "} - - - [String!]! - - - - {" "} - A list of the desired line ranges. Each list is a list - of lines, where each element is an HTML table row - '...' string. This is useful if you only need to - display specific subsets of the file.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - ranges - {" "} - -{" "} - - - [HighlightLineRange!]! - - -
-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "aborted"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "html"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lsif"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lineRanges"
-                      :{" "}
-                      [
-                      "xyz789"
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

HighlightedString

-
-
-
-
Description
-

A string that has highlights (e.g, query matches).

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - value - {" "} - -{" "} - - - String! - - - The full contents of the string.
- - highlights - {" "} - -{" "} - - - [Highlight!]! - - - - {" "} - Highlighted matches of the query in the preview - string.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "value"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "highlights"
-                      :{" "}
-                      [
-                      Highlight
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Hunk

-
-
-
-
Description
-

A hunk.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - startLine - {" "} - -{" "} - - - Int! - - - The startLine.
- - endLine - {" "} - -{" "} - - - Int! - - - The endLine.
- - startByte - {" "} - -{" "} - - - Int! - - - The startByte.
- - endByte - {" "} - -{" "} - - - Int! - - - The endByte.
- - rev - {" "} - -{" "} - - - String! - - - The rev.
- - author - {" "} - -{" "} - - - Signature! - - - The author.
- - message - {" "} - -{" "} - - - String! - - - The message.
- - commit - {" "} - -{" "} - - - GitCommit! - - - The commit that contains the hunk.
- - filename - {" "} - -{" "} - - - String! - - - - {" "} - The original filename at the commit. Use this filename - if you're reading the text contents of the file at the{" "} - commit field of this hunk. The file may - have been renamed after the commit so name of file - where this hunk got computed may not exist.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "startLine"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "endLine"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "startByte"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "endByte"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "rev"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "author"
-                      :{" "}
-                      Signature
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "message"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commit"
-                      :{" "}
-                      GitCommit
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "filename"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

ID

-
-
-
-
Description
-

- The ID scalar type represents a unique - identifier, often used to refetch an object or as key for a - cache. The ID type appears in a JSON response as a String; - however, it is not intended to be human-readable. When - expected as an input type, any string (such as{" "} - "4") or integer (such as 4) input - value will be accepted as an ID. -

-
-
-
-
-
Example
- 
-                    
-                      "4"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

IndexingProgress

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: A status message produced when - repositories are being indexed for search. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - notIndexed - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories that have not been indexed - yet.{" "} -
- - indexed - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories that have been indexed.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "notIndexed"
-                      :{" "}
-                      123
-                      ,{" "}
-                      "indexed"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Int

-
-
-
-
Description
-

- The Int scalar type represents non-fractional - signed whole numeric values. Int can represent values - between -(2^31) and 2^31 - 1. -

-
-
-
-
-
Example
- 
-                    
-                      987
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- InviteUserToOrganizationResult -

-
-
-
-
Description
-

The result of Mutation.inviteUserToOrganization.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - sentInvitationEmail - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether an invitation email was sent. If emails are - not enabled on this site or if the user has no - verified email address, an email will not be sent.{" "} -
- - invitationURL - {" "} - -{" "} - - - String! - - - - {" "} - The URL that the invited user can visit to accept or - reject the invitation.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "sentInvitationEmail"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "invitationURL"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

JSONCString

-
-
-
-
Description
-

- A string that contains valid JSON, with additional support - for //-style comments and trailing commas. -

-
-
-
-
-
Example
- 
-                    
-                      JSONCString
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

JSONValue

-
-
-
-
Description
-

A valid JSON value.

-
-
-
-
-
Example
- 
-                    
-                      JSONValue
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

KeyPathSegment

-
-
-
-
Description
-

- A segment of a key path that locates a nested JSON value in - a root JSON value. Exactly one field in each KeyPathSegment - must be non-null. For example, in {"{"}"a": [0, {"{"}"b": 3 - {"}"}]{"}"}, the value 3 is located at the key path ["a", 1, - "b"]. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- - property - {" "} - -{" "} - - - String - - - - {" "} - The name of the property in the object at this - location to descend into.{" "} -
- - index - {" "} - -{" "} - - - Int - - - - {" "} - The index of the array at this location to descend - into.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "property"
-                      :{" "}
-                      "abc123"
-                      ,{" "}
-                      "index"
-                      :{" "}
-                      987
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

KeyValuePair

-
-
-
-
Description
-

A key-value pair

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - key - {" "} - -{" "} - - - String! - - - The non-nullable key.
- - value - {" "} - -{" "} - - - String - - - - {" "} - The nullable value. A null value indicates this - key-value pair should be treated as a tag.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "key"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "value"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

LFS

-
-
-
-
Description
-

- Information about a blob stored in Git Large File Storage - (LFS). -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - byteSize - {" "} - -{" "} - - - BigInt! - - - - {" "} - The size of the file in LFS in bytes. Note: the file - size in the GitBlob will be the size of the pointer - not the file a user checks out.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "byteSize"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

LanguageStatistics

-
-
-
-
Description
-

Statistics about a language's usage.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the language.
- - totalBytes - {" "} - -{" "} - - - Float! - - - The total bytes in the language.
- - totalLines - {" "} - -{" "} - - - Int! - - - The total number of lines in the language.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalBytes"
-                      :{" "}
-                      987.65
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalLines"
-                      :{" "}
-                      123
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

LineMatch

-
-
-
-
Description
-

A line match.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - preview - {" "} - -{" "} - - - String! - - - The preview.
- - lineNumber - {" "} - -{" "} - - - Int! - - - - {" "} - The line number. 0-based. The first line will have - lineNumber 0. Note: A UI will normally display line - numbers 1-based.{" "} -
- - offsetAndLengths - {" "} - -{" "} - - - [Int!]! - - - - {" "} - Tuples of [offset, length] measured in characters (not - bytes).{" "} -
- - limitHit - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether or not the limit was hit.{" "} - - will always be false - -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "preview"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lineNumber"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "offsetAndLengths"
-                      :{" "}
-                      [
-                      123
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "limitHit"
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Location

-
-
-
-
Description
-

- A location inside a resource (in a repository at a specific - commit). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - resource - {" "} - -{" "} - - - CodeIntelGitBlob! - - - The file that this location refers to.
- - range - {" "} - -{" "} - - - Range - - - - {" "} - The range inside the file that this location refers - to.{" "} -
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this location (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this location (using an immutable - revision specifier).{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "resource"
-                      :{" "}
-                      CodeIntelGitBlob
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "range"
-                      :{" "}
-                      Range
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canonicalURL"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Markdown

-
-
-
-
Description
-

An object representing a markdown string.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - text - {" "} - -{" "} - - - String! - - - The raw markdown string.
- - html - {" "} - -{" "} - - - String! - - - - {" "} - HTML for the rendered markdown string, or null if - there is no HTML representation provided. If - specified, clients should render this directly.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "text"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "html"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

MarkdownOptions

-
-
-
-
Description
-

Describes options for rendering Markdown.

-
-
-
Fields
- - - - - - - - - - - - - -
Input FieldDescription
- - alwaysNil - {" "} - -{" "} - - - String - - - - {" "} - A dummy null value (empty input types are not allowed - yet).{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "alwaysNil"
-                      :{" "}
-                      "abc123"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

MirrorRepositoryInfo

-
-
-
-
Description
-

- Information and status about the mirroring of a repository. - In this case, the remote source repository is external to - Sourcegraph and the mirror is maintained by the Sourcegraph - site (not the other way around). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - remoteURL - {" "} - -{" "} - - - String! - - - The URL of the remote source repository.
- - cloneInProgress - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the clone of the repository has begun but not - yet completed.{" "} -
- - cloneProgress - {" "} - -{" "} - - - String - - - - {" "} - A single line of text that contains progress - information for the running clone command. The format - of the progress text is not specified. It is intended - to be displayed directly to a user. e.g. "Receiving - objects: 95% (2041/2148), 292.01 KiB | 515.00 KiB/s" - "Resolving deltas: 9% (117/1263)"{" "} -
- - cloned - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the repository has ever been successfully - cloned.{" "} -
- - isCorrupted - {" "} - -{" "} - - - Boolean! - - - Whether the repository is currently corrupt.
- - corruptionLogs - {" "} - -{" "} - - - [RepoCorruptionLog!]! - - - - {" "} - A Log of the corruption events that have been detected - on this repository. Only 10 events are kept and the - events are ordered from most recent to least.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - When the repository was last successfully updated from - the remote source repository..{" "} -
- - updateSchedule - {" "} - -{" "} - - - UpdateSchedule - - - - {" "} - The state of this repository in the update schedule.{" "} -
- - updateQueue - {" "} - -{" "} - - - UpdateQueue - - - - {" "} - The state of this repository in the update queue.{" "} -
- - lastError - {" "} - -{" "} - - - String - - - - {" "} - The last error message, if any, returned when fetching - or cloning the repo{" "} -
- - byteSize - {" "} - -{" "} - - - BigInt! - - - The byte size of the repo.
- - shard - {" "} - -{" "} - - - String - - - - {" "} - The gitserver shard on which the repository is or will - be cloned. Only site admins can access this field.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "remoteURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloneInProgress"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloneProgress"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloned"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isCorrupted"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "corruptionLogs"
-                      :{" "}
-                      [
-                      RepoCorruptionLog
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updateSchedule"
-                      :{" "}
-                      UpdateSchedule
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updateQueue"
-                      :{" "}
-                      UpdateQueue
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lastError"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "byteSize"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "shard"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

MonitoringAlert

-
-
-
-
Description
-

- A high-level monitoring alert, for details see{" "} - - https://sourcegraph.com/docs/admin/observability/metrics#high-level-alerting-metrics - -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - timestamp - {" "} - -{" "} - - - DateTime! - - - - {" "} - End time of this event, which describes the past 12h - of recorded data.{" "} -
- - name - {" "} - -{" "} - - - String! - - - Name of alert that the service fired.
- - serviceName - {" "} - -{" "} - - - String! - - - Name of the service that fired the alert.
- - owner - {" "} - -{" "} - - - String! - - - Owner of the fired alert.
- - average - {" "} - -{" "} - - - Float! - - - - {" "} - Average percentage of time (between [0, 1]) that the - event was firing over the 12h of recorded data. e.g. - 1.0 if it was firing 100% of the time on average - during that 12h window, 0.5 if it was firing 50% of - the time on average, etc.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "timestamp"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "serviceName"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "owner"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "average"
-                      :{" "}
-                      987.65
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

MonitoringStatistics

-
-
-
-
Description
-

Monitoring overview.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - alerts - {" "} - -{" "} - - - [MonitoringAlert!]! - - - - {" "} - Alerts fired in this time span.{" "} - - No longer supported, and will no longer return data - - query will be removed after Sourcegraph 4.5 - -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "alerts"
-                      :{" "}
-                      [
-                      MonitoringAlert
-                      ]
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Namespace

-
-
-
-
Description
-

- A namespace is a container for certain types of data and - settings, such as a user or organization. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The globally unique ID of this namespace.
- - namespaceName - {" "} - -{" "} - - - String! - - - - {" "} - The name of this namespace's component. For a user, - this is the username. For an organization, this is the - organization name.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL to this namespace.
-
-
-
Possible Types
- - - - - - - - - - - - - - -
Namespace Types
-

- - User - -

-
-

- - Org - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "namespaceName"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

NewRepositoryConnection

-
-
-
-
Description
-

A list of repositories.

-

- The old RepositoryConnection is deprecated and - is replaced by this new connection which support proper - cursor based pagination. The new connection does not include{" "} - precise argument for totalCount. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [Repository!]! - - - A list of repositories.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of repositories in the connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - ConnectionPageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      Repository
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      ConnectionPageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

NewUsersConnection

-
-
-
-
Description
-

A paginated connection for users.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [User!]! - - - A list of users.
- - totalCount - {" "} - -{" "} - - - Int! - - - The total number of users in the connection.
- - pageInfo - {" "} - -{" "} - - - ConnectionPageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      User
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      ConnectionPageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Node

-
-
-
-
Description
-

An object with an ID.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the node.
-
-
-
Possible Types
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Node Types
-

- - ExecutorSecret - -

-
-

- - ExecutorSecretAccessLog - -

-
-

- - User - -

-
-

- - Org - -

-
-

- - OutOfBandMigration - -

-
-

- - SavedSearch - -

-
-

- - ExternalService - -

-
-

- - ExternalServiceSyncJob - -

-
-

- - Repository - -

-
-

- - GitRef - -

-
-

- - GitCommit - -

-
-

- - AccessToken - -

-
-

- - ExternalAccount - -

-
-

- - OrganizationInvitation - -

-
-

- - SiteConfigurationChange - -

-
-

- - RegistryExtension - -

-
-

- - Webhook - -

-
-

- - WebhookLog - -

-
-

- - OutboundRequest - -

-
-

- - BackgroundJob - -

-
-

- - Executor - -

-
-

- - Team - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "id"
-                      :{" "}
-                      "4"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Org

-
-
-
-
Description
-

An organization, which is a group of users.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - executorSecrets - {" "} - -{" "} - - - ExecutorSecretConnection! - - - - {" "} - The list of all available executor secrets for - execution in this orgs namespace.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - -
-

- The scope for which secrets shall be returned. -

-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Only return N records.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque cursor for pagination.

-
-
-
-
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the organization.
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The organization's name. This is unique among all - organizations on this Sourcegraph site.{" "} -
- - displayName - {" "} - -{" "} - - - String - - - The organization's chosen display name.
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The date when the organization was created.
- - members - {" "} - -{" "} - - - NewUsersConnection! - - - - {" "} - A list of users who are members of this organization.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- The limit argument for forward pagination. -

-
-
-
- - last - {" "} - -{" "} - - - Int - - -
-

- The limit argument for backward pagination. -

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

- The cursor argument for forward pagination. -

-
-
-
- - before - {" "} - -{" "} - - - String - - -
-

- The cursor argument for backward pagination. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

- Return users whose usernames or display names - match the query. -

-
-
-
-
- - latestSettings - {" "} - -{" "} - - - Settings - - - - {" "} - The latest settings for the organization. Only - organization members and site admins can access this - field.{" "} -
- - settingsCascade - {" "} - -{" "} - - - SettingsCascade! - - - - {" "} - All settings for this organization, and the individual - levels in the settings cascade (global > - organization) that were merged to produce the final - merged settings. Only organization members and site - admins can access this field.{" "} -
- - configurationCascade - {" "} - -{" "} - - - ConfigurationCascade! - - - - {" "} - DEPRECATED{" "} - - Use settingsCascade instead. This field is a - deprecated alias for it and will be removed in a - future release. - -
- - viewerPendingInvitation - {" "} - -{" "} - - - OrganizationInvitation - - - - {" "} - DEPRECATED A pending invitation for the viewer to join - this organization, if any.{" "} - - Use invitationByToken operation instead. This field - is deprecated and will be removed in a future - release. - -
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer has admin privileges on this - organization. Currently, all of an organization's - members have admin privileges on the organization.{" "} -
- - viewerIsMember - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer is a member of this organization.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL to the organization.
- - settingsURL - {" "} - -{" "} - - - String - - - The URL to the organization's settings.
- - namespaceName - {" "} - -{" "} - - - String! - - - - {" "} - The name of this user namespace's component. For - organizations, this is the organization's name.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "executorSecrets"
-                      :{" "}
-                      
-                        ExecutorSecretConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "members"
-                      :{" "}
-                      NewUsersConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "latestSettings"
-                      :{" "}
-                      Settings
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsCascade"
-                      :{" "}
-                      SettingsCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configurationCascade"
-                      :{" "}
-                      ConfigurationCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "viewerPendingInvitation"
-                      
-                      :{" "}
-                      
-                        OrganizationInvitation
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerIsMember"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "namespaceName"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OrgConnection

-
-
-
-
Description
-

A list of organizations.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [Org!]! - - - A list of organizations.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of organizations in the connection. - This total count may be larger than the number of - nodes in this object when the result is paginated.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "nodes"
-                      :{" "}
-                      [
-                      Org
-                      ]
-                      ,{" "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OrgMembersSummary

-
-
-
-
Description
-

- Result organization members count and pending invitations - count. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the Org.
- - membersCount - {" "} - -{" "} - - - Int! - - - Total number of members for the org.
- - invitesCount - {" "} - -{" "} - - - Int! - - - Total number of pending invites for the org.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "id"
-                      :{" "}
-                      4
-                      ,{" "}
-                      "membersCount"
-                      :{" "}
-                      123
-                      ,{" "}
-                      "invitesCount"
-                      :{" "}
-                      987
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OrganizationInvitation

-
-
-
-
Description
-

An invitation to join an organization as a member.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the invitation.
- - organization - {" "} - -{" "} - - - Org! - - - The organization that the invitation is for.
- - sender - {" "} - -{" "} - - - User! - - - The user who sent the invitation.
- - recipient - {" "} - -{" "} - - - User - - - The user who received the invitation.
- - recipientEmail - {" "} - -{" "} - - - String - - - - {" "} - The email address that the invitation was sent to.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The date when this invitation was created.
- - notifiedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The most recent date when a notification was sent to - the recipient about this invitation.{" "} -
- - respondedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The date when this invitation was responded to by the - recipient.{" "} -
- - responseType - {" "} - -{" "} - - - OrganizationInvitationResponseType - - - - {" "} - The recipient's response to this invitation, or no - response (null).{" "} -
- - respondURL - {" "} - -{" "} - - - String - - - - {" "} - The URL where the recipient can respond to the - invitation when pending, or null if not pending.{" "} -
- - revokedAt - {" "} - -{" "} - - - DateTime - - - The date when this invitation was revoked.
- - expiresAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The date when this invitation is going to expire.{" "} -
- - isVerifiedEmail - {" "} - -{" "} - - - Boolean - - - - {" "} - Boolean flag which returns true if the email on the - invite matches a verified email of the user{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "organization"
-                      :{" "}
-                      Org
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "sender"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "recipient"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "recipientEmail"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "notifiedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "respondedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "responseType"
-                      :{" "}
-                      "ACCEPT"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "respondURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "revokedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "expiresAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isVerifiedEmail"
-                      :{" "}
-                      
-                        true
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- OrganizationInvitationResponseType -

-
-
-
-
Description
-

- The recipient's possible responses to an invitation to join - an organization as a member. -

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- ACCEPT -

- 		The invitation was accepted by the recipient.
-

- REJECT -

- 		The invitation was rejected by the recipient.
-
-
-
-
-
Example
- 
-                    
-                      "ACCEPT"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OrganizationMembership

-
-
-
-
Description
-

An organization membership.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - organization - {" "} - -{" "} - - - Org! - - - The organization.
- - user - {" "} - -{" "} - - - User! - - - The user.
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The time when this was created.
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - The time when this was updated.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "organization"
-                      :{" "}
-                      Org
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "user"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- OrganizationMembershipConnection -

-
-
-
-
Description
-

A list of organization memberships.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [OrganizationMembership!]! - - - A list of organization memberships.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of organization memberships in the - connection. This total count may be larger than the - number of nodes in this object when the result is - paginated.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "nodes"
-                      :{" "}
-                      [
-                      
-                        OrganizationMembership
-                      
-                      ]
-                      ,{" "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OutOfBandMigration

-
-
-
-
Description
-

- An out-of-band migration is a process that runs in the - background of the instance that moves data from one format - into another format. Out-of-band migrations -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique identifier of this migration.
- - team - {" "} - -{" "} - - - String! - - - - {" "} - The team that owns this migration (e.g., - code-intelligence).{" "} -
- - component - {" "} - -{" "} - - - String! - - - - {" "} - The component this migration affects (e.g., - codeintel-db.lsif_data_documents).{" "} -
- - description - {" "} - -{" "} - - - String! - - - A human-readable summary of the migration.
- - introduced - {" "} - -{" "} - - - String! - - - -

- The Sourcegraph version in which this migration was - introduced. The format of this version includes only - major and minor parts separated by a dot. The patch - version can always be assumed to be zero as we'll - never introduce or deprecate an out-of-band - migration within a patch release. -

-

- It is necessary to completely this migration in - reverse (if destructive) before downgrading to or - past this version. Otherwise, the previous instance - version will not be aware of the new data format. -

-
- - deprecated - {" "} - -{" "} - - - String - - - -

- The Sourcegraph version by which this migration is - assumed to have completed. The format of this - version mirrors introduced and includes only major - and minor parts separated by a dot. -

-

- It is necessary to have completed this migration - before upgrading to or past this version. Otherwise, - the next instance version will no longer be aware of - the old data format. -

-
- - progress - {" "} - -{" "} - - - Float! - - - - {" "} - The progress of the migration (in the forward - direction). In the range [0, 1].{" "} -
- - created - {" "} - -{" "} - - - DateTime! - - - The time the migration record was inserted.
- - lastUpdated - {" "} - -{" "} - - - DateTime - - - - {" "} - The last time the migration progress or error list was - updated.{" "} -
- - nonDestructive - {" "} - -{" "} - - - Boolean! - - - - {" "} - If false, the migration moves data destructively, and - a previous version of Sourcegraph will encounter - errors when interfacing with the target data unless - the migration is first run in reverse prior to a - downgrade.{" "} -
- - applyReverse - {" "} - -{" "} - - - Boolean! - - - If true, the migration will run in reverse.
- - errors - {" "} - -{" "} - - - [OutOfBandMigrationError!]! - - - - {" "} - A list of errors that have occurred while performing - this migration (in either direction). This list is - bounded by a maximum size, and older errors will - replaced by newer errors as the list capacity is - reached.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "team"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "component"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "description"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "introduced"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "deprecated"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "progress"
-                      :{" "}
-                      987.65
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "created"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lastUpdated"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "nonDestructive"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "applyReverse"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "errors"
-                      :{" "}
-                      [
-                      
-                        OutOfBandMigrationError
-                      
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OutOfBandMigrationError

-
-
-
-
Description
-

- An error that occurred while performing an out-of-band - migration. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - message - {" "} - -{" "} - - - String! - - - The error message.
- - created - {" "} - -{" "} - - - DateTime! - - - The time the error occurred.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "message"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "created"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OutboundRequest

-
-
-
-
Description
-

A single outbound request.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The request log item ID.
- - startedAt - {" "} - -{" "} - - - DateTime! - - - The time the request was sent at.
- - method - {" "} - -{" "} - - - String! - - - - {" "} - The method used in the HTTP request. E.g. GET, POST, - etc.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The full URL the request was sent to.
- - requestHeaders - {" "} - -{" "} - - - [HTTPHeader!]! - - - The headers sent with the HTTP request.
- - requestBody - {" "} - -{" "} - - - String! - - - The body content of the HTTP message.
- - statusCode - {" "} - -{" "} - - - Int! - - - The HTTP status code received.
- - responseHeaders - {" "} - -{" "} - - - [HTTPHeader!]! - - - The headers received with the HTTP response.
- - durationMs - {" "} - -{" "} - - - Int! - - - - {" "} - The total time the request took to complete, in - milliseconds.{" "} -
- - errorMessage - {" "} - -{" "} - - - String! - - - - {" "} - Any error message got from the request Doer in case of - an error, otherwise an empty string.{" "} -
- - creationStackFrame - {" "} - -{" "} - - - String! - - - - {" "} - Stack information to figure out where the - ExternalClientFactory was created.{" "} -
- - callStack - {" "} - -{" "} - - - String! - - - - {" "} - Stack information to figure out where in the code base - the request was initiated.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "startedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "method"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "requestHeaders"
-                      :{" "}
-                      [
-                      HTTPHeader
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "requestBody"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "statusCode"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "responseHeaders"
-                      :{" "}
-                      [
-                      HTTPHeader
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "durationMs"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "errorMessage"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "creationStackFrame"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "callStack"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

OutboundRequestConnection

-
-
-
-
Description
-

A list of logged outbound requests.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [OutboundRequest!]! - - - A list of outbound requests.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of outbound request log items in the - connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      OutboundRequest
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PackageRepoReference

-
-
-
-
Description
-

- A reference to a package repo, such as a maven artifact, - rust crate etc. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - A unique ID for the package repo reference.
- - scheme - {" "} - -{" "} - - - PackageRepoReferenceKind! - - - - {" "} - The ecosystem/package-manager/indexer scheme under - which this package repo reference is uniquely - identified e.g. npm/python/rust-analyzer{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The name of the package, in a format relevant to the - specific ecosystem e.g. maven artifact coordinates - (com.sample:text), npm scoped packages - (@monkeys/banana).{" "} -
- - versions - {" "} - -{" "} - - - [PackageRepoReferenceVersion!]! - - - - {" "} - The versions of this package known to the sourcegraph - instance.{" "} -
- - repository - {" "} - -{" "} - - - Repository - - - - {" "} - The synthetic repository (aka the package repo) - created to store the contents of the synced versions - of the package repo reference. This type is subject to - change once package repos and other non-git code hosts - become first-class.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "scheme"
-                      :{" "}
-                      "GOMODULES"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "versions"
-                      :{" "}
-                      [
-                      
-                        PackageRepoReferenceVersion
-                      
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repository"
-                      :{" "}
-                      Repository
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- PackageRepoReferenceConnection -

-
-
-
-
Description
-

List of package repo references.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [PackageRepoReference!]! - - - A list of package repo references.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of package repo references in the - connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      PackageRepoReference
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PackageRepoReferenceKind

-
-
-
-
Description
-

- A kind of package repo reference. ExternalServiceKind, with - a more specific set of values. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- GOMODULES -

-
-

- JVMPACKAGES -

-
-

- NPMPACKAGES -

-
-

- PYTHONPACKAGES -

-
-

- RUSTPACKAGES -

-
-

- RUBYPACKAGES -

-
-
-
-
-
-
Example
- 
-                    
-                      "GOMODULES"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PackageRepoReferenceVersion

-
-
-
-
Description
-

A version of a package repo reference.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - A unique ID for the package repo reference version.{" "} -
- - packageRepoReferenceID - {" "} - -{" "} - - - ID! - - - - {" "} - The package repo reference that this ID is for.{" "} -
- - version - {" "} - -{" "} - - - String! - - - - {" "} - The version string. Not guaranteed to be semver or any - other format.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "packageRepoReferenceID"
-                      
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "version"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PageInfo

-
-
-
-
Description
-

- Pagination information for forward-only pagination. See{" "} - - https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo - - . -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - endCursor - {" "} - -{" "} - - - String - - - - {" "} - When paginating forwards, the cursor to continue.{" "} -
- - hasNextPage - {" "} - -{" "} - - - Boolean! - - - - {" "} - When paginating forwards, are there more items?{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "endCursor"
-                      :{" "}
-                      "xyz789"
-                      ,{" "}
-                      "hasNextPage"
-                      :{" "}
-                      
-                        true
-                      
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

ParentSourcegraphDetails

-
-
-
-
Description
-

Parent Sourcegraph instance

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - url - {" "} - -{" "} - - - String! - - - Sourcegraph instance URL.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Person

-
-
-
-
Description
-

A person.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name.
- - email - {" "} - -{" "} - - - String! - - - The email.
- - displayName - {" "} - -{" "} - - - String! - - - - {" "} - The name if set; otherwise the email username.{" "} -
- - avatarURL - {" "} - -{" "} - - - String - - - The avatar URL, if known.
- - user - {" "} - -{" "} - - - User - - - - {" "} - The corresponding user account for this person, if one - exists.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "avatarURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "user"
-                      :{" "}
-                      User
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PhabricatorRepo

-
-
-
-
Description
-

A Phabricator repository.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The canonical repo name (e.g. - "github.com/gorilla/mux").{" "} -
- - uri - {" "} - -{" "} - - - String! - - - - {" "} - An alias for name.{" "} - - use name instead - -
- - callsign - {" "} - -{" "} - - - String! - - - - {" "} - The unique Phabricator identifier for the repo, like - "MUX"{" "} -
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to the phabricator instance (e.g.{" "} - - http://phabricator.sgdev.org - - ){" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "uri"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "callsign"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Position

-
-
-
-
Description
-

A zero-based position inside a file.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - line - {" "} - -{" "} - - - Int! - - - The line number (zero-based) of the position.
- - character - {" "} - -{" "} - - - Int! - - - - {" "} - The character offset (zero-based) in the line of the - position.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "line"
-                      :{" "}
-                      123
-                      ,{" "}
-                      "character"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

ProductLicenseInfo

-
-
-
-
Description
-

- Information about this site's product license (which - activates certain Sourcegraph features). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - productNameWithBrand - {" "} - -{" "} - - - String! - - - - {" "} - The full name of the product that this license is for. - To get the product name for the current Sourcegraph - site, use - ProductSubscriptionStatus.productNameWithBrand instead - (to handle cases where there is no license).{" "} -
- - tags - {" "} - -{" "} - - - [String!]! - - - - {" "} - Tags indicating the product plan and features - activated by this license.{" "} -
- - userCount - {" "} - -{" "} - - - Int! - - - The number of users allowed by this license.
- - expiresAt - {" "} - -{" "} - - - DateTime! - - - The date when this license expires.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "productNameWithBrand"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "tags"
-                      :{" "}
-                      [
-                      "xyz789"
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "userCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "expiresAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

ProductSubscriptionStatus

-
-
-
-
Description
-

- Information about this site's product subscription (which - enables access to and renewals of a product license). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - productNameWithBrand - {" "} - -{" "} - - - String! - - - - {" "} - The full name of the product in use, such as - "Sourcegraph Enterprise".{" "} -
- - actualUserCount - {" "} - -{" "} - - - Int! - - - - {" "} - The max number of user accounts that have been active - on this Sourcegraph site for the current license. If - no license is in use, returns zero.{" "} -
- - actualUserCountDate - {" "} - -{" "} - - - String! - - - - {" "} - The date and time when the max number of user accounts - that have been active on this Sourcegraph site for the - current license was reached. If no license is in use, - returns an empty string.{" "} -
- - maximumAllowedUserCount - {" "} - -{" "} - - - Int - - - - {" "} - The number of users allowed. If there is a license, - this is equal to ProductLicenseInfo.userCount. - Otherwise, it is the user limit for instances without - a license, or null if there is no limit.{" "} -
- - noLicenseWarningUserCount - {" "} - -{" "} - - - Int - - - - {" "} - The number of free users allowed on a site without a - license before a warning is shown to all users, or - null if a valid license is in use.{" "} -
- - license - {" "} - -{" "} - - - ProductLicenseInfo - - - - {" "} - The product license associated with this subscription, - if any.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "productNameWithBrand"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "actualUserCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "actualUserCountDate"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "maximumAllowedUserCount"
-                      
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "noLicenseWarningUserCount"
-                      
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "license"
-                      :{" "}
-                      ProductLicenseInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

PublicExternalAccountData

-
-
-
-
Description
-

- Public provider-specific data about the external account. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - displayName - {" "} - -{" "} - - - String - - - - {" "} - The text name the user is using on the external - account, if any.{" "} -
- - login - {" "} - -{" "} - - - String - - - - {" "} - The login or username the user is using on the - external account, if any.{" "} -
- - url - {" "} - -{" "} - - - String - - - - {" "} - Link to the user profile page for the external - account.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "login"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RandomizeUserPasswordResult

-
-
-
-
Description
-

The result for Mutation.randomizeUserPassword.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - resetPasswordURL - {" "} - -{" "} - - - String - - - -

- The reset password URL that the user must visit to - sign into their account again. If the builtin - username-password authentication provider is not - enabled, this field's value is null. -

-

- If email sending (SMTP) is configured on this - instance, an email containing this URL will also be - sent to the primary email address associated with - the user. -

-
- - emailSent - {" "} - -{" "} - - - Boolean! - - - - {" "} - If true, then an email with the password reset URL was - sent to the primary email address associated with the - user. If false, email sending (SMTP) might not be - configured on this instance, or an error may have - occurred - check the error logs with log scope - 'randomizeUserPassword' for more details.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "resetPasswordURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "emailSent"
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Range

-
-
-
-
Description
-

- A range inside a file. The start position is inclusive, and - the end position is exclusive. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - start - {" "} - -{" "} - - - Position! - - - The start position of the range (inclusive).
- - end - {" "} - -{" "} - - - Position! - - - The end position of the range (exclusive).
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "start"
-                      :{" "}
-                      Position
-                      ,{" "}
-                      "end"
-                      :{" "}
-                      Position
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Redirect

-
-
-
-
Description
-

A reference to another Sourcegraph instance.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - url - {" "} - -{" "} - - - String! - - - The URL of the other Sourcegraph instance.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RegistryExtension

-
-
-
-
Description
-

An extension's listing in the extension registry.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - The unique, opaque, permanent ID of the extension. Do - not display this ID to the user; display - RegistryExtension.extensionID instead (it is - friendlier and still unique, but it can be renamed).{" "} -
- - extensionID - {" "} - -{" "} - - - String! - - - - {" "} - The qualified, unique name that refers to this - extension, consisting of the registry name (if - non-default), publisher's name, and the extension's - name, all joined by "/" (for example, - "acme-corp/my-extension-name").{" "} -
- - manifest - {" "} - -{" "} - - - ExtensionManifest - - - - {" "} - The extension manifest, or null if none is set.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "extensionID"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "manifest"
-                      :{" "}
-                      ExtensionManifest
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RegistryExtensionConnection

-
-
-
-
Description
-

A list of registry extensions.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [RegistryExtension!]! - - - A list of registry extensions.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "nodes"
-                      :{" "}
-                      [
-                      RegistryExtension
-                      ]
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepoCorruptionLog

-
-
-
-
Description
-

- A corruption log entry that that records the time of when - corruption was detected and a reason why the repo is - regarded as corrupt -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - timestamp - {" "} - -{" "} - - - DateTime! - - - - {" "} - The time at which the repository was detected to be - corrupt{" "} -
- - reason - {" "} - -{" "} - - - String! - - - - {" "} - The reason why this repository was regarded as corrupt{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "timestamp"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "reason"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Repository

-
-
-
-
Description
-

- A repository is a Git source control repository that is - mirrored from some origin code host. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The repository's unique ID.
- - name - {" "} - -{" "} - - - String! - - - -

- The repository's name, as a path with one or more - components. It conventionally consists of the - repository's hostname and path (joined by "/"), - minus any suffixes (such as ".git"). Examples: -

-
    -
  • github.com/foo/bar
    • -
  • my-code-host.example.com/myrepo
    • -
  • myrepo
    • -
-
- - uri - {" "} - -{" "} - - - String! - - - - {" "} - DEPRECATED: Use name.{" "} - Use name. -
- - description - {" "} - -{" "} - - - String! - - - The repository's description.
- - language - {" "} - -{" "} - - - String! - - - - {" "} - The primary programming language in the repository.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - DEPRECATED: This field is unused in known clients. The - date when this repository was created on Sourcegraph.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - DEPRECATED: This field is unused in known clients. The - date when this repository's metadata was last updated - on Sourcegraph.{" "} -
- - commit - {" "} - -{" "} - - - GitCommit - - - - {" "} - Returns information about the given commit in the - repository, or null if no commit exists with the given - rev.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - rev - {" "} - -{" "} - - - String! - - -
-

- The Git revision specifier (revspec) for the - commit. -

-
-
-
- - inputRevspec - {" "} - -{" "} - - - String - - -
-

- Optional input revspec used to construct - non-canonical URLs and other "friendly" field - values. Used by clients that must ensure - consistency of revision resolution within a - session/request (so they use full SHAs) but - also preserve the user input rev (for user - friendliness). -

-
-
-
-
- - firstEverCommit - {" "} - -{" "} - - - GitCommit - - - The first commit inside the repo
- - mirrorInfo - {" "} - -{" "} - - - MirrorRepositoryInfo! - - - - {" "} - Information and status related to mirroring, if this - repository is a mirror of another repository (e.g., on - some code host). In this case, the remote source - repository is external to Sourcegraph and the mirror - is maintained by the Sourcegraph site (not the other - way around).{" "} -
- - externalRepository - {" "} - -{" "} - - - ExternalRepository! - - - - {" "} - Information about this repository from the external - service that it originates from (such as GitHub, - GitLab, Phabricator, etc.).{" "} -
- - isFork - {" "} - -{" "} - - - Boolean! - - - Whether the repository is a fork.
- - isArchived - {" "} - -{" "} - - - Boolean! - - - Whether the repository has been archived.
- - isPrivate - {" "} - -{" "} - - - Boolean! - - - Whether the repository is private.
- - externalServices - {" "} - -{" "} - - - ExternalServiceConnection! - - - - {" "} - Lists all external services which yield this - repository.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n external services from the - list. -

-
-
-
-
- - cloneInProgress - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the repository is currently being cloned.{" "} - - use Repository.mirrorInfo.cloneInProgress instead - -
- - textSearchIndex - {" "} - -{" "} - - - RepositoryTextSearchIndex - - - - {" "} - Information about the text search index for this - repository, or null if text search indexing is not - enabled or supported for this repository.{" "} -
- - url - {" "} - -{" "} - - - String! - - - The URL to this repository.
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - - {" "} - The URLs to this repository on external services - associated with it.{" "} -
- - defaultBranch - {" "} - -{" "} - - - GitRef - - - - {" "} - The repository's default Git branch (HEAD symbolic - ref). If the repository is currently being cloned or - is empty, this field will be null.{" "} -
- - gitRefs - {" "} - -{" "} - - - GitRefConnection! - - - The repository's Git refs.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n Git refs from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

- Return Git refs whose names match the query. -

-
-
-
- - type - {" "} - -{" "} - - - GitRefType - - -
-

- Return only Git refs of the given type. Known - issue: It is only supported to retrieve Git - branch and tag refs, not other Git refs. -

-
-
-
- - orderBy - {" "} - -{" "} - - - GitRefOrder - - -
-

Ordering for Git refs in the list.

-
-
-
- - interactive - {" "} - -{" "} - - - Boolean - - -
-

- Ordering is an expensive operation that - doesn't scale for lots of references. If this - is true we fallback on not ordering. This - should never be false in interactive API - requests. -

-
-
-
-
- - branches - {" "} - -{" "} - - - GitRefConnection! - - - The repository's Git branches.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n Git branches from the - list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

- Return Git branches whose names match the - query. -

-
-
-
- - orderBy - {" "} - -{" "} - - - GitRefOrder - - -
-

Ordering for Git branches in the list.

-
-
-
- - interactive - {" "} - -{" "} - - - Boolean - - -
-

- Ordering is an expensive operation that - doesn't scale for lots of references. If this - is true we fallback on not ordering. This - should never be false in interactive API - requests. -

-
-
-
-
- - tags - {" "} - -{" "} - - - GitRefConnection! - - - The repository's Git tags.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n Git tags from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

- Return Git tags whose names match the query. -

-
-
-
-
- - comparison - {" "} - -{" "} - - - RepositoryComparison! - - - - {" "} - A Git comparison in this repository between a base and - head commit.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - base - {" "} - -{" "} - - - String - - -
-

- The base of the diff ("old" or "left-hand - side"), or "HEAD" if not specified. -

-
-
-
- - head - {" "} - -{" "} - - - String - - -
-

- The head of the diff ("new" or "right-hand - side"), or "HEAD" if not specified. -

-
-
-
- - fetchMissing - {" "} - -{" "} - - - Boolean - - -
-

- Attempt to fetch missing revisions from remote - if they are not found -

-
-
-
-
- - contributors - {" "} - -{" "} - - - RepositoryContributorConnection! - - - The repository's contributors.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - revisionRange - {" "} - -{" "} - - - String - - -
-

- The Git revision range to compute contributors - in. -

-
-
-
- - afterDate - {" "} - -{" "} - - - String - - -
-

- The date after which to count contributions. -

-
-
-
- - path - {" "} - -{" "} - - - String - - -
-

- Return contributors to files in this path. -

-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n contributors from the - list. -

-
-
-
- - last - {" "} - -{" "} - - - Int - - -
-
-
-
- - after - {" "} - -{" "} - - - String - - -
-
-
-
- - before - {" "} - -{" "} - - - String - - -
-
-
-
-
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer has admin privileges on this - repository.{" "} -
- - label - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string that is rendered prominently.{" "} -
- - detail - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string of that is rendered less - prominently.{" "} -
- - matches - {" "} - -{" "} - - - [SearchResultMatch!]! - - - The result previews of the result.
- - codeIntelligenceCommitGraph - {" "} - -{" "} - - - CodeIntelligenceCommitGraph! - - - - {" "} - Information and status related to the commit graph of - this repository calculated for use by code - intelligence features.{" "} -
- - stars - {" "} - -{" "} - - - Int! - - - - {" "} - The star count the repository has in the code host.{" "} -
- - keyValuePairs - {" "} - -{" "} - - - [KeyValuePair!]! - - - - {" "} - A set of user-defined key-value pairs associated with - the repo.{" "} -
- - diskSizeBytes - {" "} - -{" "} - - - BigInt - - - The size of repo when cloned on disk
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "uri"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "description"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "language"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commit"
-                      :{" "}
-                      GitCommit
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "firstEverCommit"
-                      :{" "}
-                      GitCommit
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "mirrorInfo"
-                      :{" "}
-                      MirrorRepositoryInfo
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalRepository"
-                      :{" "}
-                      ExternalRepository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isFork"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isArchived"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isPrivate"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalServices"
-                      :{" "}
-                      
-                        ExternalServiceConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloneInProgress"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "textSearchIndex"
-                      :{" "}
-                      
-                        RepositoryTextSearchIndex
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalURLs"
-                      :{" "}
-                      [
-                      ExternalLink
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "defaultBranch"
-                      :{" "}
-                      GitRef
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "gitRefs"
-                      :{" "}
-                      GitRefConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "branches"
-                      :{" "}
-                      GitRefConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "tags"
-                      :{" "}
-                      GitRefConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "comparison"
-                      :{" "}
-                      RepositoryComparison
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "contributors"
-                      :{" "}
-                      
-                        RepositoryContributorConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "label"
-                      :{" "}
-                      Markdown
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "detail"
-                      :{" "}
-                      Markdown
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "matches"
-                      :{" "}
-                      [
-                      SearchResultMatch
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "codeIntelligenceCommitGraph"
-                      
-                      :{" "}
-                      
-                        CodeIntelligenceCommitGraph
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "stars"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "keyValuePairs"
-                      :{" "}
-                      [
-                      KeyValuePair
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "diskSizeBytes"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryComparison

-
-
-
-
Description
-

- The differences between two concrete Git commits in a - repository. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - baseRepository - {" "} - -{" "} - - - Repository! - - - - {" "} - The repository that is the base (left-hand side) of - this comparison.{" "} -
- - headRepository - {" "} - -{" "} - - - Repository! - - - - {" "} - The repository that is the head (right-hand side) of - this comparison. Cross-repository comparisons are not - yet supported, so this is always equal to - RepositoryComparison.baseRepository.{" "} -
- - range - {" "} - -{" "} - - - GitRevisionRange! - - - The range that this comparison represents.
- - commits - {" "} - -{" "} - - - GitCommitConnection! - - - - {" "} - The commits in the comparison range, excluding the - base and including the head.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Return the first n commits from the list.

-
-
-
- - path - {" "} - -{" "} - - - String - - -
-

- Filter to only the commits that modify files - that match path. Path can be either a file or - a containing directory. -

-
-
-
-
- - fileDiffs - {" "} - -{" "} - - - FileDiffConnection! - - - The file diffs for each changed file.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Return the first n file diffs from the list. -

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Return file diffs after the given cursor.

-
-
-
- - paths - {" "} - -{" "} - - - [String!] - - -
-

- A list of paths or directories used to filter - the diffs -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "baseRepository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "headRepository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "range"
-                      :{" "}
-                      GitRevisionRange
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commits"
-                      :{" "}
-                      GitCommitConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "fileDiffs"
-                      :{" "}
-                      FileDiffConnection
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryContributor

-
-
-
-
Description
-

A contributor to a repository.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - person - {" "} - -{" "} - - - Person! - - - The personal information for the contributor.
- - count - {" "} - -{" "} - - - Int! - - - - {" "} - The number of contributions made by this contributor.{" "} -
- - repository - {" "} - -{" "} - - - Repository! - - - - {" "} - The repository in which the contributions occurred.{" "} -
- - commits - {" "} - -{" "} - - - GitCommitConnection! - - - Commits by the contributor.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Return the first n commits.

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "person"
-                      :{" "}
-                      Person
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "count"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commits"
-                      :{" "}
-                      GitCommitConnection
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- RepositoryContributorConnection -

-
-
-
-
Description
-

A list of contributors to a repository.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [RepositoryContributor!]! - - - A list of contributors to a repository.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of contributors in the connection, if - available. This total count may be larger than the - number of nodes in this object when the result is - paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - BidirectionalPageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      RepositoryContributor
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      BidirectionalPageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryOrderBy

-
-
-
-
Description
-

- RepositoryOrderBy enumerates the ways a repositories list - can be ordered. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- REPOSITORY_NAME -

-
-

- REPO_CREATED_AT -

-
-

- REPOSITORY_CREATED_AT -

- 		- {" "} - deprecated (use the equivalent REPOSITORY_CREATED_AT){" "} -
-

- SIZE -

-
-
-
-
-
-
Example
- 
-                    
-                      "REPOSITORY_NAME"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryRedirect

-
-
-
-
Description
-

- A repository or a link to another Sourcegraph instance - location where this repository may be located. -

-
-
-
Types
- - - - - - - - - - - - - - -
Union Types
-

- - Repository - -

-
-

- - Redirect - -

-
-
-
-
-
-
Example
- 
-                    
-                      Repository
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryStats

-
-
-
-
Description
-

FOR INTERNAL USE ONLY: A repository statistic

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - gitDirBytes - {" "} - -{" "} - - - BigInt! - - - - {" "} - The amount of bytes stored in .git directories{" "} -
- - indexedLinesCount - {" "} - -{" "} - - - BigInt! - - - The number of lines indexed
- - total - {" "} - -{" "} - - - Int! - - - - {" "} - The number of all repositories in the instance, - without soft-deleted or blocked repositories.{" "} -
- - cloned - {" "} - -{" "} - - - Int! - - - - {" "} - The number of cloned repositories in the instance. - This number might be higher than 'total', if - soft-deleted repositories haven't been cleaned up yet.{" "} -
- - cloning - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories in the instance that are - currently being cloned.{" "} -
- - notCloned - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories in the instance that not - cloned yet.{" "} -
- - failedFetch - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories where initial cloning or - subsequent fetching resulted in an error.{" "} -
- - indexed - {" "} - -{" "} - - - Int! - - - The number of indexed repositories
- - corrupted - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories that are currently corrupt{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "gitDirBytes"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexedLinesCount"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "total"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloned"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloning"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "notCloned"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "failedFetch"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexed"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "corrupted"
-                      :{" "}
-                      123
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

RepositoryTextSearchIndex

-
-
-
-
Description
-

Information about a repository's text search index.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - repository - {" "} - -{" "} - - - Repository! - - - The indexed repository.
- - status - {" "} - -{" "} - - - RepositoryTextSearchIndexStatus - - - - {" "} - The status of the text search index, if available.{" "} -
- - refs - {" "} - -{" "} - - - [RepositoryTextSearchIndexedRef!]! - - - - {" "} - Git refs in the repository that are configured for - text search indexing.{" "} -
- - host - {" "} - -{" "} - - - repositoryIndexserverHost - - - - {" "} - Information about the indexserver that hosts the - repo's index.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "repository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "status"
-                      :{" "}
-                      
-                        RepositoryTextSearchIndexStatus
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "refs"
-                      :{" "}
-                      [
-                      
-                        RepositoryTextSearchIndexedRef
-                      
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "host"
-                      :{" "}
-                      
-                        repositoryIndexserverHost
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- RepositoryTextSearchIndexStatus -

-
-
-
-
Description
-

The status of a repository's text search index.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - The date that the index was last updated.
- - contentByteSize - {" "} - -{" "} - - - BigInt! - - - The byte size of the original content.
- - contentFilesCount - {" "} - -{" "} - - - Int! - - - The number of files in the original content.
- - indexByteSize - {" "} - -{" "} - - - Int! - - - The byte size of the index.
- - indexShardsCount - {" "} - -{" "} - - - Int! - - - The number of index shards.
- - newLinesCount - {" "} - -{" "} - - - Int! - - - - {" "} - EXPERIMENTAL: The number of newlines appearing in the - index.{" "} -
- - defaultBranchNewLinesCount - {" "} - -{" "} - - - Int! - - - - {" "} - EXPERIMENTAL: The number of newlines in the default - branch.{" "} -
- - otherBranchesNewLinesCount - {" "} - -{" "} - - - Int! - - - - {" "} - EXPERIMENTAL: The number of newlines in the other - branches.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "contentByteSize"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "contentFilesCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexByteSize"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexShardsCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "newLinesCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "defaultBranchNewLinesCount"
-                      
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "otherBranchesNewLinesCount"
-                      
-                      :{" "}
-                      123
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- RepositoryTextSearchIndexedRef -

-
-
-
-
Description
-

- A Git ref (usually a branch) in a repository that is - configured to be indexed for text search. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - ref - {" "} - -{" "} - - - GitRef! - - - - {" "} - The Git ref (usually a branch) that is configured to - be indexed for text search. To find the specific - commit SHA that was indexed, use - RepositoryTextSearchIndexedRef.indexedCommit; this - field's ref target resolves to the current target, not - the target at the time of indexing.{" "} -
- - indexed - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether a text search index exists for this ref.{" "} -
- - current - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the text search index is of the current commit - for the Git ref. If false, the index is stale.{" "} -
- - indexedCommit - {" "} - -{" "} - - - GitObject - - - - {" "} - The indexed Git commit (which may differ from the - ref's current target if the index is out of date). If - indexed is false, this field's value is null.{" "} -
- - skippedIndexed - {" "} - -{" "} - - - SkippedIndexed - - - - {" "} - EXPERIMENTAL: Information about the files that were - not indexed.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "ref"
-                      :{" "}
-                      GitRef
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexed"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "current"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexedCommit"
-                      :{" "}
-                      GitObject
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "skippedIndexed"
-                      :{" "}
-                      SkippedIndexed
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SavedSearch

-
-
-
-
Description
-

A saved search query, defined in settings.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID of this saved query.
- - description - {" "} - -{" "} - - - String! - - - The description.
- - query - {" "} - -{" "} - - - String! - - - The query.
- - notify - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether or not to notify the owner of the saved search - via email. This owner is either a single user, or - every member of an organization that owns the saved - search.{" "} -
- - notifySlack - {" "} - -{" "} - - - Boolean! - - - Whether or not to notify on Slack.
- - namespace - {" "} - -{" "} - - - Namespace! - - - The user or org that owns this saved search.
- - slackWebhookURL - {" "} - -{" "} - - - String - - - - {" "} - The Slack webhook URL associated with this saved - search, if any.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "description"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "query"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "notify"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "notifySlack"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "namespace"
-                      :{" "}
-                      Namespace
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "slackWebhookURL"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SavedSearchesConnection

-
-
-
-
Description
-

- A paginated connection for saved search queries, defined in - settings. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [SavedSearch!]! - - - A list of saved searches.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of saved searches in the connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - ConnectionPageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      SavedSearch
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      ConnectionPageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
- -
-
- Types -
-

SearchAlert

-
-
-
-
Description
-

A search-related alert message.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - title - {" "} - -{" "} - - - String! - - - The title.
- - description - {" "} - -{" "} - - - String - - - The description.
- - kind - {" "} - -{" "} - - - String - - - An identifier indicating the kind of alert
- - proposedQueries - {" "} - -{" "} - - - [SearchQueryDescription!] - - - "Did you mean: ____" query proposals
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "title"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "description"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "kind"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "proposedQueries"
-                      :{" "}
-                      [
-                      
-                        SearchQueryDescription
-                      
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchFilter

-
-
-
-
Description
-

A search filter.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - value - {" "} - -{" "} - - - String! - - - The value.
- - label - {" "} - -{" "} - - - String! - - - The string to be displayed in the UI.
- - count - {" "} - -{" "} - - - Int! - - - Number of matches for a given filter.
- - limitHit - {" "} - -{" "} - - - Boolean! - - - Whether the results returned are incomplete.
- - kind - {" "} - -{" "} - - - String! - - - - {" "} - The kind of filter. Should be "file" or "repo".{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "value"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "label"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "count"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "limitHit"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "kind"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchPatternType

-
-
-
-
Description
-

The search pattern type.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- standard -

-
-

- literal -

-
-

- regexp -

-
-

- structural -

-
-

- lucky -

-
-

- keyword -

-
-
-
-
-
-
Example
- 
-                    
-                      "standard"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchQueryAnnotation

-
-
-
-
Description
-

- Additional information describing attributes of a query. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - A name for this query annotation label.
- - value - {" "} - -{" "} - - - String! - - - An opaque value for this query annotation.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "value"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchQueryDescription

-
-
-
-
Description
-

A search query description.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - description - {" "} - -{" "} - - - String - - - The description.
- - query - {" "} - -{" "} - - - String! - - - The query.
- - annotations - {" "} - -{" "} - - - [SearchQueryAnnotation!] - - - - {" "} - Additional optional information describing attributes - of this query.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "description"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "query"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "annotations"
-                      :{" "}
-                      [
-                      SearchQueryAnnotation
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchQueryOutputFormat

-
-
-
-
Description
-

The output format to emit for a parsed query.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- JSON -

- 		JSON format.
-

- SEXP -

- 		S-expression format.
-

- MERMAID -

- 		Mermaid flowchart format.
-
-
-
-
-
Example
- 
-                    
-                      "JSON"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchQueryOutputPhase

-
-
-
-
Description
-

- Represents phases in query parsing. The parse tree - corresponds closely to the input query syntax. A subsequent - processing phase on the parse tree generates a job tree. The - job tree is an internal representation analogous to a - database query plan. The job tree discards information about - query syntax and corresponds closely to backend services - (text search, git commit search, etc.). -

-
-
-
Values
- - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- PARSE_TREE -

-
-

- JOB_TREE -

-
-
-
-
-
-
Example
- 
-                    
-                      "PARSE_TREE"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchQueryOutputVerbosity

-
-
-
-
Description
-

The output format to emit for a parsed query.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- MINIMAL -

- 		Minimal verbosity outputs only nodes.
-

- BASIC -

- 		- {" "} - Basic verbosity outputs nodes and essential fields - associated with nodes.{" "} -
-

- MAXIMAL -

- 		- {" "} - Maximal verbosity outputs nodes and all information - associated with nodes.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      "MINIMAL"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchResult

-
-
-
-
Description
-

A search result.

-
-
-
Types
- - - - - - - - - - - - - - - - - -
Union Types
-

- - FileMatch - -

-
-

- - CommitSearchResult - -

-
-

- - Repository - -

-
-
-
-
-
-
Example
- 
-                    
-                      FileMatch
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchResultMatch

-
-
-
-
Description
-

- A match in a search result. Matches make up the body content - of a search result. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - url - {" "} - -{" "} - - - String! - - - URL for the individual result match.
- - body - {" "} - -{" "} - - - Markdown! - - - - {" "} - A markdown string containing the preview contents of - the result match.{" "} -
- - highlights - {" "} - -{" "} - - - [Highlight!]! - - - - {" "} - A list of highlights that specify locations of matches - of the query in the body. Each highlight is a line - number, character offset, and length. Currently, - highlights are only displayed on match bodies that are - code blocks. If the result body is a code block, - exclude the markdown code fence lines in the line and - character count. Leave as an empty list if no - highlights are available.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "body"
-                      :{" "}
-                      Markdown
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "highlights"
-                      :{" "}
-                      [
-                      Highlight
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchResults

-
-
-
-
Description
-

Search results.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - results - {" "} - -{" "} - - - [SearchResult!]! - - - - {" "} - The results. Inside each SearchResult there may be - multiple matches, e.g. a FileMatch may contain - multiple line matches.{" "} -
- - matchCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of matches returned by this search. - This is different than the length of the results array - in that e.g. a single results array entry may contain - multiple matches. For example, the results array may - contain two file matches and this field would report 6 - ("3 line matches per file") while the length of the - results array would report 3 ("3 FileMatch results"). - Typically, 'approximateResultCount', not this field, - is shown to users.{" "} -
- - resultCount - {" "} - -{" "} - - - Int! - - - - {" "} - DEPRECATED: Renamed to 'matchCount' for less - ambiguity.{" "} - - renamed to matchCount for less ambiguity - -
- - approximateResultCount - {" "} - -{" "} - - - String! - - - - {" "} - The approximate number of results. This is like the - length of the results array, except it can indicate - the number of results regardless of whether or not the - limit was hit. Currently, this is represented as e.g. - "5+" results. This string is typically shown to users - to indicate the true result count.{" "} -
- - limitHit - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether or not the results limit was hit. In paginated - requests, this field is always false. Use - 'pageInfo.hasNextPage' instead.{" "} -
- - sparkline - {" "} - -{" "} - - - [Int!]! - - - - {" "} - Integers representing the sparkline for the search - results.{" "} -
- - repositories - {" "} - -{" "} - - - [Repository!]! - - - Repositories from results.
- - repositoriesCount - {" "} - -{" "} - - - Int! - - - - {" "} - The number of repositories that had results (for - clients that just wish to know how many without - querying the, sometimes extremely large, list).{" "} -
- - cloning - {" "} - -{" "} - - - [Repository!]! - - - - {" "} - Repositories that are busy cloning onto gitserver. In - paginated search requests, some repositories may be - cloning. These are reported here and you may choose to - retry the paginated request with the same cursor after - they have cloned OR you may simply continue making - further paginated requests and choose to skip the - cloning repositories.{" "} -
- - missing - {" "} - -{" "} - - - [Repository!]! - - - - {" "} - Repositories or commits that do not exist. In - paginated search requests, some repositories may be - missing (e.g. if Sourcegraph is aware of them but is - temporarily unable to serve them). These are reported - here and you may choose to retry the paginated request - with the same cursor and they may no longer be missing - OR you may simply continue making further paginated - requests and choose to skip the missing repositories.{" "} -
- - timedout - {" "} - -{" "} - - - [Repository!]! - - - - {" "} - Repositories or commits which we did not manage to - search in time. Trying again usually will work. In - paginated search requests, this field is not relevant.{" "} -
- - indexUnavailable - {" "} - -{" "} - - - Boolean! - - - - {" "} - DEPRECATED: This field is not used in known clients, - and will always return false. True if - indexed search is enabled but was not available during - this search.{" "} -
- - alert - {" "} - -{" "} - - - SearchAlert - - - - {" "} - An alert message that should be displayed before any - results.{" "} -
- - elapsedMilliseconds - {" "} - -{" "} - - - Int! - - - The time it took to generate these results.
- - dynamicFilters - {" "} - -{" "} - - - [SearchFilter!]! - - - - {" "} - Dynamic filters generated by the search results{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "results"
-                      :{" "}
-                      [
-                      FileMatch
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "matchCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "resultCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "approximateResultCount"
-                      
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "limitHit"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "sparkline"
-                      :{" "}
-                      [
-                      987
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repositories"
-                      :{" "}
-                      [
-                      Repository
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repositoriesCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "cloning"
-                      :{" "}
-                      [
-                      Repository
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "missing"
-                      :{" "}
-                      [
-                      Repository
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "timedout"
-                      :{" "}
-                      [
-                      Repository
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "indexUnavailable"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "alert"
-                      :{" "}
-                      SearchAlert
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "elapsedMilliseconds"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "dynamicFilters"
-                      :{" "}
-                      [
-                      SearchFilter
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchResultsStats

-
-
-
-
Description
-

Statistics about search results.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - approximateResultCount - {" "} - -{" "} - - - String! - - - The approximate number of results returned.
- - sparkline - {" "} - -{" "} - - - [Int!]! - - - The sparkline.
- - languages - {" "} - -{" "} - - - [LanguageStatistics!]! - - - - {" "} - Statistics about the languages represented in the - search results. Known issue: The - LanguageStatistics.totalBytes field values are - incorrect in the result.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      
-                        "approximateResultCount"
-                      
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "sparkline"
-                      :{" "}
-                      [
-                      987
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "languages"
-                      :{" "}
-                      [
-                      LanguageStatistics
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SearchVersion

-
-
-
-
Description
-

The version of the search syntax.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- V1 -

- 		Search syntax that defaults to regexp search.
-

- V2 -

- 		- {" "} - Search syntax that defaults to literal-only search.{" "} -
-

- V3 -

- 		- {" "} - Search syntax that defaults to standard search.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      "V1"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Session

-
-
-
-
Description
-

An active user session.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - canSignOut - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the user can sign out of this session on - Sourcegraph.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "canSignOut"
-                      :{" "}
-                      
-                        true
-                      
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Settings

-
-
-
-
Description
-

Settings is a version of a configuration settings file.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - Int! - - - The ID.
- - subject - {" "} - -{" "} - - - SettingsSubject! - - - The subject that these settings are for.
- - author - {" "} - -{" "} - - - User - - - - {" "} - The author, or null if there is no author or the - authoring user was deleted.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The time when this was created.
- - contents - {" "} - -{" "} - - - JSONCString! - - - - {" "} - The stringified JSON contents of the settings. The - contents may include "//"-style comments and trailing - commas in the JSON.{" "} -
- - configuration - {" "} - -{" "} - - - Configuration! - - - - {" "} - DEPRECATED: This field will be removed in a future - release. The configuration.{" "} - - use the contents field instead - -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "subject"
-                      :{" "}
-                      SettingsSubject
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "author"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "contents"
-                      :{" "}
-                      JSONCString
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configuration"
-                      :{" "}
-                      Configuration
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SettingsCascade

-
-
-
-
Description
-

- The configurations for all of the relevant settings - subjects, plus the merged settings. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - subjects - {" "} - -{" "} - - - [SettingsSubject!]! - - - - {" "} - The other settings subjects that are applied with - lower precedence than this subject to form the final - merged settings. For example, a user in 2 - organizations would have the following settings - subjects: site (global settings), org 1, org 2, and - the user.{" "} -
- - final - {" "} - -{" "} - - - String! - - - - {" "} - The effective final merged settings as (stringified) - JSON, merged from all of the subjects.{" "} -
- - merged - {" "} - -{" "} - - - Configuration! - - - - {" "} - DEPRECATED: This field will be removed in a future - release. The effective final merged settings, merged - from all of the subjects.{" "} - - use final instead - -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "subjects"
-                      :{" "}
-                      [
-                      SettingsSubject
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "final"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "merged"
-                      :{" "}
-                      Configuration
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SettingsEdit

-
-
-
-
Description
-

- An edit to a JSON property in a settings JSON object. The - JSON property to edit can be nested. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - keyPath - {" "} - -{" "} - - - [KeyPathSegment!]! - - - -

The key path of the property to update.

-

- Inserting into an existing array is not yet - supported. -

-
- - value - {" "} - -{" "} - - - JSONValue - - - -

- The new JSON-encoded value to insert. If the field's - value is not set, the property is removed. (This is - different from the field's value being the JSON null - value.) -

-

- When the value is a non-primitive type, it must be - specified using a GraphQL variable, not an inline - literal, or else the GraphQL parser will return an - error. -

-
- - valueIsJSONCEncodedString - {" "} - -{" "} - - - Boolean - - - - {" "} - Whether to treat the value as a JSONC-encoded string, - which makes it possible to perform an edit that - preserves (or adds/removes) comments. Default ={" "} - false{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "keyPath"
-                      :{" "}
-                      [
-                      KeyPathSegment
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "value"
-                      :{" "}
-                      JSONValue
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "valueIsJSONCEncodedString"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SettingsMutation

-
-
-
-
Description
-

- Mutations that update settings (global, organization, or - user settings). These mutations are grouped together because - they: -

-
    -
  • - are all versioned to avoid race conditions with concurrent - editors -
    • -
  • - all apply to a specific settings subject (i.e., a user, an - organization, or the whole site) -
    • -
-

- Grouping them lets us extract those common parameters to the - Mutation.settingsMutation field. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - editSettings - {" "} - -{" "} - - - UpdateSettingsPayload - - - - {" "} - Edit a single property in the settings object.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - edit - {" "} - -{" "} - - - SettingsEdit! - - -
-

The edit to apply to the settings.

-
-
-
-
- - editConfiguration - {" "} - -{" "} - - - UpdateSettingsPayload - - - - {" "} - DEPRECATED{" "} - - Use editSettings instead. This field is a deprecated - alias for it and will be removed in a future - release. - -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - edit - {" "} - -{" "} - - - ConfigurationEdit! - - -
-
-
-
-
- - overwriteSettings - {" "} - -{" "} - - - UpdateSettingsPayload - - - - {" "} - Overwrite the existing settings with the new settings.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - contents - {" "} - -{" "} - - - String! - - -
-

- A JSON object (stringified) of the settings. - Trailing commas and "//"-style comments are - supported. The entire previous settings value - will be overwritten by this new value. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "editSettings"
-                      :{" "}
-                      UpdateSettingsPayload
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "editConfiguration"
-                      :{" "}
-                      UpdateSettingsPayload
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "overwriteSettings"
-                      :{" "}
-                      UpdateSettingsPayload
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SettingsMutationGroupInput

-
-
-
-
Description
-

- Input for Mutation.settingsMutation, which contains fields - that all settings (global, organization, and user settings) - mutations need. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- - subject - {" "} - -{" "} - - - ID! - - - - {" "} - The subject whose settings to mutate (organization, - user, etc.).{" "} -
- - lastID - {" "} - -{" "} - - - Int - - - - {" "} - The ID of the last-known settings known to the client, - or null if there is none. This field is used to - prevent race conditions when there are concurrent - editors.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "subject"
-                      :{" "}
-                      4
-                      ,{" "}
-                      "lastID"
-                      :{" "}
-                      987
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SettingsSubject

-
-
-
-
Description
-

- SettingsSubject is something that can have settings: a site - ("global settings", which is different from "site - configuration"), an organization, or a user. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID.
- - latestSettings - {" "} - -{" "} - - - Settings - - - The latest settings.
- - settingsURL - {" "} - -{" "} - - - String - - - The URL to the settings.
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer can modify the subject's settings.{" "} -
- - settingsCascade - {" "} - -{" "} - - - SettingsCascade! - - - - {" "} - All settings for this subject, and the individual - levels in the settings cascade (global > - organization > user) that were merged to produce - the final merged settings.{" "} -
- - configurationCascade - {" "} - -{" "} - - - ConfigurationCascade! - - - - {" "} - DEPRECATED{" "} - - Use settingsCascade instead. This field is a - deprecated alias for it and will be removed in a - future release. - -
-
-
-
Possible Types
- - - - - - - - - - - - - - - - - - - - -
SettingsSubject Types
-

- - User - -

-
-

- - Org - -

-
-

- - DefaultSettings - -

-
-

- - Site - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "latestSettings"
-                      :{" "}
-                      Settings
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsCascade"
-                      :{" "}
-                      SettingsCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configurationCascade"
-                      :{" "}
-                      ConfigurationCascade
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Signature

-
-
-
-
Description
-

A signature.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - person - {" "} - -{" "} - - - Person! - - - The person.
- - date - {" "} - -{" "} - - - String! - - - The date.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "person"
-                      :{" "}
-                      Person
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "date"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Site

-
-
-
-
Description
-

- A site is an installation of Sourcegraph that consists of - one or more servers that share the same configuration and - database. The site is a singleton; the API only ever returns - the single global site. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - - {" "} - The site's opaque GraphQL ID. This is NOT the "site - ID" as it is referred to elsewhere; use the siteID - field for that. (GraphQL node types conventionally - have an id field of type ID! that globally identifies - the node.){" "} -
- - siteID - {" "} - -{" "} - - - String! - - - The site ID.
- - configuration - {" "} - -{" "} - - - SiteConfiguration! - - - - {" "} - The site's configuration. Only visible to site admins.{" "} -
- - latestSettings - {" "} - -{" "} - - - Settings - - - - {" "} - The site's latest site-wide settings (which are the - second-lowest-precedence in the configuration cascade - for a user).{" "} -
- - settingsCascade - {" "} - -{" "} - - - SettingsCascade! - - - - {" "} - The global settings for this site, and the final - merged settings. All viewers can access this field.{" "} -
- - configurationCascade - {" "} - -{" "} - - - ConfigurationCascade! - - - - {" "} - DEPRECATED{" "} - - Use settingsCascade instead. This field is a - deprecated alias for it and will be removed in a - future release. - -
- - settingsURL - {" "} - -{" "} - - - String - - - The URL to the site's settings.
- - canReloadSite - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer can reload the site (with the - reloadSite mutation).{" "} -
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer can modify the subject's settings.{" "} -
- - accessTokens - {" "} - -{" "} - - - AccessTokenConnection! - - - A list of all access tokens on this site.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n access tokens from the - list. -

-
-
-
-
- - authProviders - {" "} - -{" "} - - - AuthProviderConnection! - - - - {" "} - A list of all authentication providers. This - information is visible to all viewers and does not - contain any secret information.{" "} -
- - externalAccounts - {" "} - -{" "} - - - ExternalAccountConnection! - - - - {" "} - A list of all user external accounts on this site.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n external accounts from the - list. -

-
-
-
- - user - {" "} - -{" "} - - - ID - - -
-

- Include only external accounts associated with - this user. -

-
-
-
- - serviceType - {" "} - -{" "} - - - String - - -
-

- Include only external accounts with this - service type. -

-
-
-
- - serviceID - {" "} - -{" "} - - - String - - -
-

- Include only external accounts with this - service ID. -

-
-
-
- - clientID - {" "} - -{" "} - - - String - - -
-

- Include only external accounts with this - client ID. -

-
-
-
-
- - buildVersion - {" "} - -{" "} - - - String! - - - - {" "} - The build version of the Sourcegraph software that is - running on this site (of the form - NNNNN_YYYY-MM-DD_XXXXX, like 12345_2018-01-01_abcdef).{" "} -
- - productVersion - {" "} - -{" "} - - - String! - - - - {" "} - The product version of the Sourcegraph software that - is running on this site.{" "} -
- - updateCheck - {" "} - -{" "} - - - UpdateCheck! - - - - {" "} - Information about software updates for the version of - Sourcegraph that this site is running.{" "} -
- - needsRepositoryConfiguration - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the site needs to be configured to add - repositories.{" "} -
- - externalServicesFromFile - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the external services haven been created from - a configuration file specified in the - EXTSVC_CONFIG_FILE.{" "} -
- - allowEditExternalServicesWithFile - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the external services can be updated even if{" "} - externalServicesFromFile is true. All - changes made while{" "} - externalServicesFromFile is true will be - discarded once Sourcegraph restarts.{" "} -
- - freeUsersExceeded - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the site is over the limit for free user - accounts, and a warning needs to be shown to all - users. Only applies if the site does not have a valid - license.{" "} -
- - alerts - {" "} - -{" "} - - - [Alert!]! - - - Alerts to display to the viewer.
- - hasCodeIntelligence - {" "} - -{" "} - - - Boolean! - - - BACKCOMPAT: Always returns true.
- - sendsEmailVerificationEmails - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the server sends emails to users to verify - email addresses. If false, then site admins must - manually verify users' email addresses.{" "} -
- - productSubscription - {" "} - -{" "} - - - ProductSubscriptionStatus! - - - - {" "} - Information about this site's product subscription - status.{" "} -
- - usageStatistics - {" "} - -{" "} - - - SiteUsageStatistics! - - - Usage statistics for this site.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - days - {" "} - -{" "} - - - Int - - -
-

- Days of history (based on current UTC time). -

-
-
-
- - weeks - {" "} - -{" "} - - - Int - - -
-

- Weeks of history (based on current UTC time). -

-
-
-
- - months - {" "} - -{" "} - - - Int - - -
-

- Months of history (based on current UTC time). -

-
-
-
-
- - analytics - {" "} - -{" "} - - - Analytics! - - - New usage statistics/analytics for this site.
- - users - {" "} - -{" "} - - - SiteUsers! - - - List all users.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

- Return users whose usernames or display names - match the query. -

-
-
-
- - siteAdmin - {" "} - -{" "} - - - Boolean - - -
-

- Returns users who have been active in a given - period of time. -

-
-
-
- - username - {" "} - -{" "} - - - String - - -
-

- Returns users that contain filter in the - username field. -

-
-
-
- - email - {" "} - -{" "} - - - String - - -
-

- Returns users that contain filter in the email - field. -

-
-
-
- - lastActiveAt - {" "} - -{" "} - - - SiteUsersDateRangeInput - - -
-

- Returns users for the given lastActive enum - period. When omitted does NOT apply and - returns for all period available. -

-
-
-
- - deletedAt - {" "} - -{" "} - - - SiteUsersDateRangeInput - - -
-

- Returns either deleted or not deleted users. - Returns all users when omitted. -

-
-
-
- - createdAt - {" "} - -{" "} - - - SiteUsersDateRangeInput - - -
-

- Returns users who where created within a given - date time range. -

-
-
-
- - eventsCount - {" "} - -{" "} - - - SiteUsersNumberRangeInput - - -
-

- Returns users whose events count within a - given range. -

-
-
-
-
- - monitoringStatistics - {" "} - -{" "} - - - MonitoringStatistics! - - - - {" "} - Monitoring overview for this site. Note: This is - primarily used for displaying recently-fired alerts in - the web app. If your intent is to monitor Sourcegraph, - it is better to configure alerting or query Prometheus - directly in order to ensure that if the frontend goes - down you still receive alerts: Configure alerting:{" "} - - https://sourcegraph.com/docs/admin/observability/alerting - {" "} - Query Prometheus directly:{" "} - - https://sourcegraph.com/docs/admin/observability/alerting_custom_consumption - {" "} -
- - allowSiteSettingsEdits - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether changes can be made to site settings through - the API. When global settings are configured through - the GLOBAL_SETTINGS_FILE environment variable, site - settings edits cannot be made through the API.{" "} -
- - enableLegacyExtensions - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether to enable the extension registry and the use - of extensions. Reflects the site configuration{" "} - enableLegacyExtensions experimental - feature value.{" "} -
- - upgradeReadiness - {" "} - -{" "} - - - UpgradeReadiness! - - - - {" "} - FOR INTERNAL USE ONLY: Returns information about - instance upgrade readiness.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "siteID"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configuration"
-                      :{" "}
-                      SiteConfiguration
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "latestSettings"
-                      :{" "}
-                      Settings
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsCascade"
-                      :{" "}
-                      SettingsCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configurationCascade"
-                      :{" "}
-                      ConfigurationCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canReloadSite"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "accessTokens"
-                      :{" "}
-                      AccessTokenConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "authProviders"
-                      :{" "}
-                      
-                        AuthProviderConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalAccounts"
-                      :{" "}
-                      
-                        ExternalAccountConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "buildVersion"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "productVersion"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updateCheck"
-                      :{" "}
-                      UpdateCheck
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "needsRepositoryConfiguration"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "externalServicesFromFile"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "allowEditExternalServicesWithFile"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "freeUsersExceeded"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "alerts"
-                      :{" "}
-                      [
-                      Alert
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "hasCodeIntelligence"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "sendsEmailVerificationEmails"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "productSubscription"
-                      :{" "}
-                      
-                        ProductSubscriptionStatus
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "usageStatistics"
-                      :{" "}
-                      SiteUsageStatistics
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "analytics"
-                      :{" "}
-                      Analytics
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "users"
-                      :{" "}
-                      SiteUsers
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "monitoringStatistics"
-                      :{" "}
-                      MonitoringStatistics
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "allowSiteSettingsEdits"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "enableLegacyExtensions"
-                      
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "upgradeReadiness"
-                      :{" "}
-                      UpgradeReadiness
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteConfiguration

-
-
-
-
Description
-

The configuration for a site.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - Int! - - - - {" "} - The unique identifier of this site configuration - version.{" "} -
- - effectiveContents - {" "} - -{" "} - - - JSONCString! - - - The effective configuration JSON.
- - validationMessages - {" "} - -{" "} - - - [String!]! - - - - {" "} - Messages describing validation problems or usage of - deprecated configuration in the configuration JSON. - This includes both JSON Schema validation problems and - other messages that perform more advanced checks on - the configuration (that can't be expressed in the JSON - Schema).{" "} -
- - history - {" "} - -{" "} - - - SiteConfigurationChangeConnection - - - - {" "} - EXPERIMENTAL: A list of diffs to depict what changed - since the previous version of this configuration. Only - site admins may perform this query.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- The number of nodes to return starting from - the beginning (oldest). Note: Use either first - or last (see below) in the query. Setting both - will return an error. -

-
-
-
- - last - {" "} - -{" "} - - - Int - - -
-

- The number of nodes to return starting from - the end (latest). Note: Use either last or - first (see above) in the query. Setting both - will return an error. -

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

- Opaque pagination cursor to be used when - paginating forwards that may be also used in - conjunction with "first" to return the first N - nodes. -

-
-
-
- - before - {" "} - -{" "} - - - String - - -
-

- Opaque pagination cursor to be used when - paginating backwards that may be also used in - conjunction with "last" to return the last N - nodes. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "effectiveContents"
-                      :{" "}
-                      JSONCString
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "validationMessages"
-                      :{" "}
-                      [
-                      "abc123"
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "history"
-                      :{" "}
-                      
-                        SiteConfigurationChangeConnection
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteConfigurationChange

-
-
-
-
Description
-

- A diff representing the change in the site config compared - to the previous version. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The ID of the site config in the history.
- - author - {" "} - -{" "} - - - User - - - - {" "} - The user who made this change. If empty, it indicates - that either the author's information is not available - or the change in the site config was applied via an - internal process (example: site startup or - SITE_CONFIG_FILE being reloaded).{" "} -
- - reproducedDiff - {" "} - -{" "} - - - Boolean! - - - - {" "} - A flag to indicate if the diff of changes to the - previous site configuration was reproduced or not. - Sometimes it may not be possible to generate a diff - (for example the redacted contents are not available) - in which case the value of the flag will be false.{" "} -
- - diff - {" "} - -{" "} - - - String - - - - {" "} - The diff string when diffed against the previous site - config. When this is null there was no diff to the - previous change.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The timestamp when this change in the site config was - applied.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The timestamp when this change in the site config was - modified. Usually this should be the same as createdAt - as entries in the site config history are considered - immutable.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "author"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "reproducedDiff"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "diff"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

- SiteConfigurationChangeConnection -

-
-
-
-
Description
-

A list of site config diffs.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [SiteConfigurationChange!]! - - - A list of diffs in the site config
- - totalCount - {" "} - -{" "} - - - Int! - - - The total number of diffs in the connection.
- - pageInfo - {" "} - -{" "} - - - ConnectionPageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      
-                        SiteConfigurationChange
-                      
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      ConnectionPageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUsagePeriod

-
-
-
-
Description
-

- SiteUsagePeriod describes a site's usage statistics for a - given timespan. This information is visible to all viewers. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - startTime - {" "} - -{" "} - - - String! - - - The time when this started.
- - userCount - {" "} - -{" "} - - - Int! - - - The user count.
- - registeredUserCount - {" "} - -{" "} - - - Int! - - - The registered user count.
- - anonymousUserCount - {" "} - -{" "} - - - Int! - - - The anonymous user count.
- - integrationUserCount - {" "} - -{" "} - - - Int! - - - - {" "} - The count of registered users that have been active on - a code host integration. Excludes anonymous users.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "startTime"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "userCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "registeredUserCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "anonymousUserCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "integrationUserCount"
-                      :{" "}
-                      123
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUsageStatistics

-
-
-
-
Description
-

- SiteUsageStatistics describes a site's aggregate usage - statistics. This information is visible to all viewers. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - daus - {" "} - -{" "} - - - [SiteUsagePeriod!]! - - - Recent daily active users.
- - waus - {" "} - -{" "} - - - [SiteUsagePeriod!]! - - - Recent weekly active users.
- - maus - {" "} - -{" "} - - - [SiteUsagePeriod!]! - - - Recent monthly active users.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "daus"
-                      :{" "}
-                      [
-                      SiteUsagePeriod
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "waus"
-                      :{" "}
-                      [
-                      SiteUsagePeriod
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "maus"
-                      :{" "}
-                      [
-                      SiteUsagePeriod
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUser

-
-
-
-
Description
-

Site user.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the user.
- - username - {" "} - -{" "} - - - String! - - - User's username.
- - email - {" "} - -{" "} - - - String - - - User's primary email.
- - displayName - {" "} - -{" "} - - - String - - - User's display name
- - createdAt - {" "} - -{" "} - - - String! - - - - {" "} - The datetime when user was created in the system.{" "} -
- - lastActiveAt - {" "} - -{" "} - - - String - - - The datetime when user was last active.
- - deletedAt - {" "} - -{" "} - - - String - - - The datetime when user was deleted.
- - siteAdmin - {" "} - -{" "} - - - Boolean! - - - Whether user is site admin or not.
- - eventsCount - {" "} - -{" "} - - - Float! - - - Total number of user's event_logs.
- - locked - {" "} - -{" "} - - - Boolean! - - - Whether or not the user account is locked.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "username"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lastActiveAt"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "deletedAt"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "siteAdmin"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "eventsCount"
-                      :{" "}
-                      123.45
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "locked"
-                      :{" "}
-                      
-                        true
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUserOrderBy

-
-
-
-
Description
-

- SiteUserOrderBy enumerates the ways a users list can be - ordered. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- USERNAME -

-
-

- EMAIL -

- 		User's primary email.
-

- EVENTS_COUNT -

- 		The total number of user's event_logs.
-

- LAST_ACTIVE_AT -

- 		The last event_log datetime.
-

- CREATED_AT -

- 		- {" "} - The datetime when user was added to the system.{" "} -
-

- DELETED_AT -

- 		The datetime when user was soft deleted.
-

- SITE_ADMIN -

- 		Whether the user is site admin or not.
-
-
-
-
-
Example
- 
-                    
-                      "USERNAME"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUsers

-
-
-
-
Description
-

Site users.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - totalCount - {" "} - -{" "} - - - Float! - - - User total count.
- - nodes - {" "} - -{" "} - - - [SiteUser!]! - - - List of users.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - limit - {" "} - -{" "} - - - Int - - -
-

- Returns the "limit" number users from the - list. -

-
-
-
- - offset - {" "} - -{" "} - - - Int - - -
-

Skips initial "offset" number of users.

-
-
-
- - orderBy - {" "} - -{" "} - - - SiteUserOrderBy - - -
-

Returns users ordered by a given column.

-
-
-
- - descending - {" "} - -{" "} - - - Boolean - - -
-

- Returns ordered users in descending order - provided by orderBy field. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "totalCount"
-                      :{" "}
-                      987.65
-                      ,{" "}
-                      "nodes"
-                      :{" "}
-                      [
-                      SiteUser
-                      ]
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUsersDateRangeInput

-
-
-
-
Description
-

- SiteUsersDateRangeInput argument to filter based on date - range or date equals to null -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - lte - {" "} - -{" "} - - - DateTime - - - Less than or equal to
- - gte - {" "} - -{" "} - - - DateTime - - - Greater than or equal to
- - not - {" "} - -{" "} - - - Boolean - - - Negation
- - empty - {" "} - -{" "} - - - Boolean - - - Equal to Null
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "lte"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "gte"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "not"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "empty"
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SiteUsersNumberRangeInput

-
-
-
-
Description
-

- SiteUsersNumberRangeInput argument to filter based on the - number range -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Input FieldDescription
- - gte - {" "} - -{" "} - - - Float - - - Less than or equal to
- - lte - {" "} - -{" "} - - - Float - - - Greater than or equal to
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "gte"
-                      :{" "}
-                      123.45
-                      ,{" "}
-                      "lte"
-                      :{" "}
-                      123.45
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SkippedIndexed

-
-
-
-
Description
-

- EXPERIMENTAL: Information about the files that were not - indexed. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - count - {" "} - -{" "} - - - BigInt! - - - The count of files that were not indexed.
- - query - {" "} - -{" "} - - - String! - - - - {" "} - The query to retrieve the list of files that were not - indexed.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "count"
-                      :{" "}
-                      {"{"}
-                      {"}"}
-                      ,{" "}
-                      "query"
-                      :{" "}
-                      "abc123"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SlowRequest

-
-
-
-
Description
-

A logged slow GraphQL request, captured by the backend.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - index - {" "} - -{" "} - - - String! - - - The index of this request.
- - start - {" "} - -{" "} - - - DateTime! - - - The date at which this request was started.
- - duration - {" "} - -{" "} - - - Float! - - - The duration of the request.
- - user - {" "} - -{" "} - - - User - - - - {" "} - The user associated with that request, if any.{" "} -
- - name - {" "} - -{" "} - - - String! - - - The name of the GraphQL request.
- - source - {" "} - -{" "} - - - String! - - - The source from which the request originated.
- - repository - {" "} - -{" "} - - - Repository - - - - {" "} - The repository referenced by the request, if any.{" "} -
- - variables - {" "} - -{" "} - - - String! - - - - {" "} - The variables used to build the GraphQL request.{" "} -
- - errors - {" "} - -{" "} - - - [String!]! - - - The errors returned if the request failed.
- - query - {" "} - -{" "} - - - String! - - - The GraphQL query.
- - filepath - {" "} - -{" "} - - - String - - - - {" "} - The file path referenced by the request, if any.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "index"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "start"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "duration"
-                      :{" "}
-                      123.45
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "user"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "source"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "repository"
-                      :{" "}
-                      Repository
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "variables"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "errors"
-                      :{" "}
-                      [
-                      "xyz789"
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "query"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "filepath"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SlowRequestConnection

-
-
-
-
Description
-

The result for Query.slowRequests.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [SlowRequest!]! - - - A list of slow graphql requests logs.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of slow graphql logs in the - connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      SlowRequest
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

StatusMessage

-
-
-
-
Description
-

FOR INTERNAL USE ONLY: A status message

-
-
-
Types
- - - - - - - - - - - - - - - - - - - - - - - -
Union Types
-

- - GitUpdatesDisabled - -

-
-

- - CloningProgress - -

-
-

- - ExternalServiceSyncError - -

-
-

- - SyncError - -

-
-

- - IndexingProgress - -

-
-
-
-
-
-
Example
- 
-                    
-                      GitUpdatesDisabled
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

String

-
-
-
-
Description
-

- The String scalar type represents textual data, - represented as UTF-8 character sequences. The String type is - most often used by GraphQL to represent free-form - human-readable text. -

-
-
-
-
-
Example
- 
-                    
-                      "abc123"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Submodule

-
-
-
-
Description
-

A Git submodule

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - url - {" "} - -{" "} - - - String! - - - The remote repository URL of the submodule.
- - commit - {" "} - -{" "} - - - String! - - - The commit of the submodule.
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The path to which the submodule is checked out.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "commit"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "path"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SurveyResponse

-
-
-
-
Description
-

- An individual response to a user satisfaction (NPS) survey. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID of the survey response
- - user - {" "} - -{" "} - - - User - - - - {" "} - The user who submitted the survey (if they were - authenticated at the time).{" "} -
- - email - {" "} - -{" "} - - - String - - - - {" "} - The email that the user manually entered (if they were - NOT authenticated at the time).{" "} -
- - score - {" "} - -{" "} - - - Int! - - - - {" "} - User's likelihood of recommending Sourcegraph to a - friend, from 0-10.{" "} -
- - reason - {" "} - -{" "} - - - String - - - - {" "} - The answer to "What is the most important reason for - the score you gave".{" "} -
- - better - {" "} - -{" "} - - - String - - - - {" "} - The answer to "What can Sourcegraph do to provide a - better product"{" "} -
- - otherUseCase - {" "} - -{" "} - - - String - - - - {" "} - The answer to "What do you use Sourcegraph for?".{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - The time when this response was created.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "user"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "score"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "reason"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "better"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "otherUseCase"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SurveyResponseConnection

-
-
-
-
Description
-

A list of survey responses

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [SurveyResponse!]! - - - A list of survey responses.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of survey responses in the connection. - This total count may be larger than the number of - nodes in this object when the result is paginated.{" "} -
- - last30DaysCount - {" "} - -{" "} - - - Int! - - - - {" "} - The count of survey responses submitted since 30 - calendar days ago at 00:00 UTC.{" "} -
- - averageScore - {" "} - -{" "} - - - Float! - - - - {" "} - The average score of survey responses in the - connection submitted since 30 calendar days ago at - 00:00 UTC.{" "} -
- - netPromoterScore - {" "} - -{" "} - - - Int! - - - - {" "} - The net promoter score (NPS) of survey responses in - the connection submitted since 30 calendar days ago at - 00:00 UTC. Return value is a signed integer, scaled - from -100 (all detractors) to +100 (all promoters). - See{" "} - - https://en.wikipedia.org/wiki/Net_Promoter - {" "} - for explanation.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      SurveyResponse
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "last30DaysCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "averageScore"
-                      :{" "}
-                      987.65
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "netPromoterScore"
-                      :{" "}
-                      987
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SurveySubmissionInput

-
-
-
-
Description
-

Input for a user satisfaction (NPS) survey submission.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - email - {" "} - -{" "} - - - String - - - - {" "} - User-provided email address, if there is no currently - authenticated user. If there is, this value will not - be used.{" "} -
- - score - {" "} - -{" "} - - - Int! - - - - {" "} - User's likelihood of recommending Sourcegraph to a - friend, from 0-10.{" "} -
- - otherUseCase - {" "} - -{" "} - - - String - - - - {" "} - The answer to "What do you use Sourcegraph for?".{" "} -
- - better - {" "} - -{" "} - - - String - - - - {" "} - The answer to "What would make Sourcegraph better?"{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "score"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "otherUseCase"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "better"
-                      :{" "}
-                      "abc123"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Symbol

-
-
-
-
Description
-

- A code symbol (e.g., a function, variable, type, class, - etc.). It is derived from DocumentSymbol as defined in the - Language Server Protocol (see{" "} - - https://microsoft.github.io/language-server-protocol/specifications/specification-3-14/#textDocument_documentSymbol - - ). -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The name of the symbol.
- - containerName - {" "} - -{" "} - - - String - - - - {" "} - The name of the symbol that contains this symbol, if - any. This field's value is not guaranteed to be - structured in such a way that callers can infer a - hierarchy of symbols.{" "} -
- - kind - {" "} - -{" "} - - - SymbolKind! - - - The kind of the symbol.
- - language - {" "} - -{" "} - - - String! - - - The programming language of the symbol.
- - location - {" "} - -{" "} - - - Location! - - - The location where this symbol is defined.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this symbol (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this symbol (using an immutable - revision specifier).{" "} -
- - fileLocal - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether or not the symbol is local to the file it's - defined in.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "containerName"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "kind"
-                      :{" "}
-                      "UNKNOWN"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "language"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "location"
-                      :{" "}
-                      Location
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canonicalURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "fileLocal"
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SymbolConnection

-
-
-
-
Description
-

A list of symbols.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [Symbol!]! - - - A list of symbols.
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      Symbol
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SymbolKind

-
-
-
-
Description
-

- All possible kinds of symbols. This set matches that of the - Language Server Protocol ( - - https://microsoft.github.io/language-server-protocol/specification#workspace_symbol - - ). -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- UNKNOWN -

-
-

- FILE -

-
-

- MODULE -

-
-

- NAMESPACE -

-
-

- PACKAGE -

-
-

- CLASS -

-
-

- METHOD -

-
-

- PROPERTY -

-
-

- FIELD -

-
-

- CONSTRUCTOR -

-
-

- ENUM -

-
-

- INTERFACE -

-
-

- FUNCTION -

-
-

- VARIABLE -

-
-

- CONSTANT -

-
-

- STRING -

-
-

- NUMBER -

-
-

- BOOLEAN -

-
-

- ARRAY -

-
-

- OBJECT -

-
-

- KEY -

-
-

- NULL -

-
-

- ENUMMEMBER -

-
-

- STRUCT -

-
-

- EVENT -

-
-

- OPERATOR -

-
-

- TYPEPARAMETER -

-
-
-
-
-
-
Example
- 
-                    
-                      "UNKNOWN"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

SyncError

-
-
-
-
Description
-

- FOR INTERNAL USE ONLY: A status message produced when - repositories could not be synced -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - message - {" "} - -{" "} - - - String! - - - The message of this status message
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "message"
-                      :{" "}
-                      "xyz789"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Team

-
-
-
-
Description
-

- A team is a grouping of users/persons into a common handle. - Teams are commonly used to define codeowners. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID of the team.
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The name of the team. Needs to be globally unique - across usernames, organization names, and team names. - Team names can use alphanumeric characters, - dash and - / forward slash.{" "} -
- - url - {" "} - -{" "} - - - String! - - - URL to link to the teams profile page.
- - displayName - {" "} - -{" "} - - - String - - - - {" "} - A human readable name substitute for the name. Null, - if not defined.{" "} -
- - readonly - {" "} - -{" "} - - - Boolean! - - - - {" "} - A team can be made read-only from the CLI instructing - the UI to show a warning banner that this is managed - externally, and management features will only be - available to site-admins. It can also still be - manipulated from the CLI.{" "} -
- - members - {" "} - -{" "} - - - TeamMemberConnection! - - - - {" "} - The teams direct members. That is members that are - strictly part of this team, but not members of child - teams. Team membership is NOT inherited.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n team members from the - list. -

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - search - {" "} - -{" "} - - - String - - -
-

- Optionally apply a text search filter over the - results. -

-
-
-
-
- - parentTeam - {" "} - -{" "} - - - Team - - - - {" "} - Parent team can be null, if this is a root team.{" "} -
- - childTeams - {" "} - -{" "} - - - TeamConnection! - - - The list of direct child teams.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n teams from the list.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - search - {" "} - -{" "} - - - String - - -
-

- Optionally apply a text search filter over the - results. -

-
-
-
-
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - True, if the current user can modify this team.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "readonly"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "members"
-                      :{" "}
-                      TeamMemberConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "parentTeam"
-                      :{" "}
-                      Team
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "childTeams"
-                      :{" "}
-                      TeamConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        true
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

TeamConnection

-
-
-
-
Description
-

A list of teams.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - totalCount - {" "} - -{" "} - - - Int! - - - The total count of items in the connection.
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - The pagination info for the connection.
- - nodes - {" "} - -{" "} - - - [Team!]! - - - The current page of teams in this connection.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      Team
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

TeamMember

-
-
-
-
Description
-

- A team member is an entity that can be associated to a team. -

-

- For now, this will be User, and will be expanded to User | - Person later. -

-
-
-
Fields
- - - - - - - - - - - - - - - - -
Field NameDescription
- - teams - {" "} - -{" "} - - - TeamConnection! - - - - {" "} - All the teams this TeamMember is a direct member of.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n teams from the list.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - search - {" "} - -{" "} - - - String - - -
-

- Optionally apply a text search filter over the - results. -

-
-
-
-
-
-
-
Possible Types
- - - - - - - - - - - -
TeamMember Types
-

- - User - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "teams"
-                      :{" "}
-                      TeamConnection
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

TeamMemberConnection

-
-
-
-
Description
-

A list of team members.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - totalCount - {" "} - -{" "} - - - Int! - - - The total count of items in the connection.
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - The pagination info for the connection.
- - nodes - {" "} - -{" "} - - - [TeamMember!]! - - - - {" "} - The current page of team members in this connection.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      TeamMember
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

TemporarySettings

-
-
-
-
Description
-

Temporary settings for a user.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - contents - {" "} - -{" "} - - - String! - - - - {" "} - A JSON string representing the temporary settings.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "contents"
-                      :{" "}
-                      "abc123"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

TreeEntry

-
-
-
-
Description
-

A file, directory, or other tree entry.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the repository root) of - this tree entry.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., file name only) of this tree - entry.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - Whether this tree entry is a directory.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL to this tree entry (using the input revision - specifier, which may not be immutable).{" "} -
- - canonicalURL - {" "} - -{" "} - - - String! - - - - {" "} - The canonical URL to this tree entry (using an - immutable revision specifier).{" "} -
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - - {" "} - The URLs to this tree entry on external services.{" "} -
- - symbols - {" "} - -{" "} - - - SymbolConnection! - - - Symbols defined in this file or directory.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n symbols from the list. -

-
-
-
- - query - {" "} - -{" "} - - - String - - -
-

Return symbols matching the query.

-
-
-
-
- - submodule - {" "} - -{" "} - - - Submodule - - - - {" "} - Submodule metadata if this tree points to a submodule{" "} -
- - isSingleChild - {" "} - -{" "} - - - Boolean! - - - Whether this tree entry is a single child
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n files in the tree.

-
-
-
- - recursive - {" "} - -{" "} - - - Boolean - - -
-

Recurse into sub-trees.

-
-
-
- - recursiveSingleChild - {" "} - -{" "} - - - Boolean - - -
-

- Recurse into sub-trees of single-child - directories -

-
-
-
-
-
-
-
Possible Types
- - - - - - - - - - - - - - -
TreeEntry Types
-

- - GitTree - -

-
-

- - GitBlob - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "path"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isDirectory"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canonicalURL"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalURLs"
-                      :{" "}
-                      [
-                      ExternalLink
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "symbols"
-                      :{" "}
-                      SymbolConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "submodule"
-                      :{" "}
-                      Submodule
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isSingleChild"
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpdateCheck

-
-
-
-
Description
-

Information about software updates for Sourcegraph.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - pending - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether an update check is currently in progress.{" "} -
- - checkedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - When the last update check was completed, or null if - no update check has been completed (or performed) yet.{" "} -
- - errorMessage - {" "} - -{" "} - - - String - - - - {" "} - If an error occurred during the last update check, - this message describes the error.{" "} -
- - updateVersionAvailable - {" "} - -{" "} - - - String - - - - {" "} - If an update is available, the version string of the - updated version.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "pending"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "checkedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "errorMessage"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "updateVersionAvailable"
-                      
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpdateExternalServiceInput

-
-
-
-
Description
-

Fields to update for an existing external service.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Input FieldDescription
- - id - {" "} - -{" "} - - - ID! - - - The id of the external service to update.
- - displayName - {" "} - -{" "} - - - String - - - The updated display name, if provided.
- - config - {" "} - -{" "} - - - String - - - The updated config, if provided.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "config"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpdateQueue

-
-
-
-
Description
-

The state of a repository in the update queue.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - index - {" "} - -{" "} - - - Int! - - - - {" "} - The index of the repo in the update queue. Updating - repos are placed at the end of the queue until they - finish updating so don't display this if updating is - true.{" "} -
- - updating - {" "} - -{" "} - - - Boolean! - - - True if the repo is currently updating.
- - total - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of repos in the update queue - (including updating repos).{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "index"
-                      :{" "}
-                      123
-                      ,{" "}
-                      "updating"
-                      :{" "}
-                      
-                        false
-                      
-                      ,{" "}
-                      "total"
-                      :{" "}
-                      123
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpdateSchedule

-
-
-
-
Description
-

The state of a repository in the update schedule.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - intervalSeconds - {" "} - -{" "} - - - Int! - - - - {" "} - The interval that was used when scheduling the current - due time.{" "} -
- - due - {" "} - -{" "} - - - DateTime! - - - - {" "} - The next time that the repo will be inserted into the - update queue.{" "} -
- - index - {" "} - -{" "} - - - Int! - - - The index of the repo in the schedule.
- - total - {" "} - -{" "} - - - Int! - - - The total number of repos in the schedule.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "intervalSeconds"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "due"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "index"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "total"
-                      :{" "}
-                      123
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpdateSettingsPayload

-
-
-
-
Description
-

The payload for SettingsMutation.updateConfiguration.

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - empty - {" "} - -{" "} - - - EmptyResponse - - - An empty response.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "empty"
-                      :{" "}
-                      EmptyResponse
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UpgradeReadiness

-
-
-
-
Description
-

- Instance upgrade readiness information includes schema - drifts and deprecated-but-unfinished out-of-band migrations. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - schemaDrift - {" "} - -{" "} - - - String! - - - The schema drift details.
- - requiredOutOfBandMigrations - {" "} - -{" "} - - - [OutOfBandMigration!]! - - - - {" "} - The list of deprecated-but-unfinished out-of-band - migrations.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "schemaDrift"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "requiredOutOfBandMigrations"
-                      
-                      :{" "}
-                      [
-                      OutOfBandMigration
-                      ]
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

User

-
-
-
-
Description
-

A user.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - executorSecrets - {" "} - -{" "} - - - ExecutorSecretConnection! - - - - {" "} - The list of all available executor secrets for - execution in this users namespace.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - scope - {" "} - -{" "} - - - ExecutorSecretScope! - - -
-

- The scope for which secrets shall be returned. -

-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Only return N records.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque cursor for pagination.

-
-
-
-
- - id - {" "} - -{" "} - - - ID! - - - The unique ID for the user.
- - username - {" "} - -{" "} - - - String! - - - The user's username.
- - email - {" "} - -{" "} - - - String! - - - - {" "} - The user's primary email address. Only the user and - site admins can access this field.{" "} - - use emails instead - -
- - displayName - {" "} - -{" "} - - - String - - - The display name chosen by the user.
- - avatarURL - {" "} - -{" "} - - - String - - - The URL of the user's avatar image.
- - url - {" "} - -{" "} - - - String! - - - The URL to the user's profile on Sourcegraph.
- - settingsURL - {" "} - -{" "} - - - String - - - The URL to the user's settings.
- - createdAt - {" "} - -{" "} - - - DateTime! - - - - {" "} - The date when the user account was created on - Sourcegraph.{" "} -
- - updatedAt - {" "} - -{" "} - - - DateTime - - - - {" "} - The date when the user account was last updated on - Sourcegraph.{" "} -
- - siteAdmin - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the user is a site admin. Only the user and - site admins can access this field.{" "} -
- - builtinAuth - {" "} - -{" "} - - - Boolean! - - - Whether the user account uses built in auth.
- - latestSettings - {" "} - -{" "} - - - Settings - - - - {" "} - The latest settings for the user. Only the user and - site admins can access this field.{" "} -
- - settingsCascade - {" "} - -{" "} - - - SettingsCascade! - - - - {" "} - All settings for this user, and the individual levels - in the settings cascade (global > organization > - user) that were merged to produce the final merged - settings. Only the user and site admins can access - this field.{" "} -
- - configurationCascade - {" "} - -{" "} - - - ConfigurationCascade! - - - - {" "} - DEPRECATED{" "} - - Use settingsCascade instead. This field is a - deprecated alias for it and will be removed in a - future release. - -
- - organizations - {" "} - -{" "} - - - OrgConnection! - - - - {" "} - The organizations that this user is a member of.{" "} -
- - organizationMemberships - {" "} - -{" "} - - - OrganizationMembershipConnection! - - - This user's organization memberships.
- - tags - {" "} - -{" "} - - - [String!]! - - - - {" "} - Tags associated with the user. These are used for - internal site management and feature selection. Only - the user and site admins can access this field.{" "} -
- - tosAccepted - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the user has already accepted the terms of - service or not.{" "} -
- - searchable - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the user accepted to be searched in the users - picker or not.{" "} -
- - usageStatistics - {" "} - -{" "} - - - UserUsageStatistics! - - - The user's usage statistics on Sourcegraph.
- - eventLogs - {" "} - -{" "} - - - EventLogsConnection! - - - The user's events on Sourcegraph.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n event logs from the list. -

-
-
-
- - eventName - {" "} - -{" "} - - - String - - -
-

- Only return events matching this event name -

-
-
-
-
- - emails - {" "} - -{" "} - - - [UserEmail!]! - - - - {" "} - The user's email addresses. Only the user and site - admins can access this field.{" "} -
- - accessTokens - {" "} - -{" "} - - - AccessTokenConnection! - - - - {" "} - The user's access tokens (which grant to the holder - the privileges of the user). This consists of all - access tokens whose subject is this user. Only the - user and site admins can access this field.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n access tokens from the - list. -

-
-
-
-
- - externalAccounts - {" "} - -{" "} - - - ExternalAccountConnection! - - - - {" "} - A list of external accounts that are associated with - the user.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

- Returns the first n external accounts from the - list. -

-
-
-
-
- - session - {" "} - -{" "} - - - Session! - - - - {" "} - The user's currently active session. Only the - currently authenticated user can access this field. - Site admins are not able to access sessions for other - users.{" "} -
- - viewerCanAdminister - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer has admin privileges on this user. - The user has admin privileges on their own user, and - site admins have admin privileges on all users.{" "} -
- - viewerCanChangeUsername - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer can change the username of this - user. The user can change their username unless - auth.disableUsernameChanges is set. Site admins can - always change the username of any user.{" "} -
- - surveyResponses - {" "} - -{" "} - - - [SurveyResponse!]! - - - - {" "} - The user's survey responses. Only the user and site - admins can access this field.{" "} -
- - databaseID - {" "} - -{" "} - - - Int! - - - - {" "} - The unique numeric ID for the user. FOR INTERNAL USE - ONLY.{" "} -
- - namespaceName - {" "} - -{" "} - - - String! - - - - {" "} - The name of this user namespace's component. For - users, this is the username.{" "} -
- - invitableCollaborators - {" "} - -{" "} - - - [Person!]! - - - - {" "} - EXPERIMENTAL: Collaborators who can be invited to - Sourcegraph. This typically comes from a few - repositories this user has access to, and is derived - from recent commit history of those.{" "} -
- - teams - {" "} - -{" "} - - - TeamConnection! - - - - {" "} - All the teams this user is a direct member of.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n teams from the list.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - search - {" "} - -{" "} - - - String - - -
-

- Optionally apply a text search filter over the - results. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "executorSecrets"
-                      :{" "}
-                      
-                        ExecutorSecretConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "username"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "displayName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "avatarURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "siteAdmin"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "builtinAuth"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "latestSettings"
-                      :{" "}
-                      Settings
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "settingsCascade"
-                      :{" "}
-                      SettingsCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "configurationCascade"
-                      :{" "}
-                      ConfigurationCascade
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "organizations"
-                      :{" "}
-                      OrgConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "organizationMemberships"
-                      
-                      :{" "}
-                      
-                        OrganizationMembershipConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "tags"
-                      :{" "}
-                      [
-                      "xyz789"
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "tosAccepted"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "searchable"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "usageStatistics"
-                      :{" "}
-                      UserUsageStatistics
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "eventLogs"
-                      :{" "}
-                      EventLogsConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "emails"
-                      :{" "}
-                      [
-                      UserEmail
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "accessTokens"
-                      :{" "}
-                      AccessTokenConnection
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalAccounts"
-                      :{" "}
-                      
-                        ExternalAccountConnection
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "session"
-                      :{" "}
-                      Session
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "viewerCanAdminister"
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "viewerCanChangeUsername"
-                      
-                      :{" "}
-                      
-                        true
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "surveyResponses"
-                      :{" "}
-                      [
-                      SurveyResponse
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "databaseID"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "namespaceName"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "invitableCollaborators"
-                      
-                      :{" "}
-                      [
-                      Person
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "teams"
-                      :{" "}
-                      TeamConnection
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UserActivePeriod

-
-
-
-
Description
-

- A period of time in which a set of users have been active. -

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- TODAY -

- 		Since today at 00:00 UTC.
-

- THIS_WEEK -

- 		Since the latest Monday at 00:00 UTC.
-

- THIS_MONTH -

- 		- {" "} - Since the first day of the current month at 00:00 UTC.{" "} -
-

- ALL_TIME -

- 		All time.
-
-
-
-
-
Example
- 
-                    
-                      "TODAY"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UserConnection

-
-
-
-
Description
-

A list of users.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [User!]! - - - A list of users.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total count of users in the connection. This total - count may be larger than the number of nodes in this - object when the result is paginated.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      User
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UserEmail

-
-
-
-
Description
-

A user's email address.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - email - {" "} - -{" "} - - - String! - - - The email address.
- - isPrimary - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the email address is the user's primary email - address. Currently this is defined as the earliest - email address associated with the user, preferring - verified emails to unverified emails.{" "} -
- - verified - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the email address has been verified by the - user.{" "} -
- - verificationPending - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the email address is pending verification.{" "} -
- - user - {" "} - -{" "} - - - User! - - - The user associated with this email address.
- - viewerCanManuallyVerify - {" "} - -{" "} - - - Boolean! - - - - {" "} - Whether the viewer has privileges to manually mark - this email address as verified (without the user going - through the normal verification process). Only site - admins have this privilege.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "email"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isPrimary"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "verified"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "verificationPending"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "user"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "viewerCanManuallyVerify"
-                      
-                      :{" "}
-                      
-                        false
-                      
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UserEvent

-
-
-
-
Description
-

A user event.

-
-
-
Values
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Enum ValueDescription
-

- PAGEVIEW -

-
-

- SEARCHQUERY -

-
-

- CODEINTEL -

-
-

- CODEINTELREFS -

-
-

- CODEINTELINTEGRATION -

-
-

- CODEINTELINTEGRATIONREFS -

-
-

- STAGEMANAGE -

- 		Product stages
-

- STAGEPLAN -

-
-

- STAGECODE -

-
-

- STAGEREVIEW -

-
-

- STAGEVERIFY -

-
-

- STAGEPACKAGE -

-
-

- STAGEDEPLOY -

-
-

- STAGECONFIGURE -

-
-

- STAGEMONITOR -

-
-

- STAGESECURE -

-
-

- STAGEAUTOMATE -

-
-
-
-
-
-
Example
- 
-                    
-                      "PAGEVIEW"
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

UserUsageStatistics

-
-
-
-
Description
-

- UserUsageStatistics describes a user's usage statistics. - This information is visible to all viewers. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - searchQueries - {" "} - -{" "} - - - Int! - - - - {" "} - The number of search queries that the user has - performed.{" "} -
- - pageViews - {" "} - -{" "} - - - Int! - - - - {" "} - The number of page views that the user has performed.{" "} -
- - codeIntelligenceActions - {" "} - -{" "} - - - Int! - - - - {" "} - The number of code intelligence actions that the user - has performed.{" "} -
- - findReferencesActions - {" "} - -{" "} - - - Int! - - - - {" "} - The number of find-refs actions that the user has - performed.{" "} -
- - lastActiveTime - {" "} - -{" "} - - - String - - - - {" "} - The last time the user was active (any action, any - platform).{" "} -
- - lastActiveCodeHostIntegrationTime - {" "} - -{" "} - - - String - - - - {" "} - The last time the user was active on a code host - integration.{" "} -
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "searchQueries"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageViews"
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "codeIntelligenceActions"
-                      
-                      :{" "}
-                      987
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "findReferencesActions"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "lastActiveTime"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      
-                        "lastActiveCodeHostIntegrationTime"
-                      
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

VirtualFile

-
-
-
-
Description
-

- A virtual file is an arbitrary file that is generated in - memory. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - path - {" "} - -{" "} - - - String! - - - - {" "} - The full path (relative to the root) of this file.{" "} -
- - name - {" "} - -{" "} - - - String! - - - - {" "} - The base name (i.e., file name only) of this file.{" "} -
- - isDirectory - {" "} - -{" "} - - - Boolean! - - - - {" "} - False because this is a file, not a directory.{" "} -
- - content - {" "} - -{" "} - - - String! - - - The content of this file.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return file content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return file content ending at line "endLine". - A value < 0 or > totalLines will set - endLine to the end of the file. -

-
-
-
-
- - byteSize - {" "} - -{" "} - - - Int! - - - The file size in bytes.
- - totalLines - {" "} - -{" "} - - - Int! - - - - {" "} - Total line count for the file. Returns 0 for binary - files.{" "} -
- - binary - {" "} - -{" "} - - - Boolean! - - - Whether or not it is binary.
- - richHTML - {" "} - -{" "} - - - String! - - - - {" "} - The file rendered as rich HTML, or an empty string if - it is not a supported rich file type. This HTML string - is already escaped and thus is always safe to render.{" "} -
-
-
- {" "} - Arguments{" "} -
-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content starting at line - "startLine". A value <= 0 will be the start - of the file. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return richHTML content ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. -

-
-
-
-
- - url - {" "} - -{" "} - - - String! - - - Not implemented.
- - canonicalURL - {" "} - -{" "} - - - String! - - - Not implemented.
- - externalURLs - {" "} - -{" "} - - - [ExternalLink!]! - - - Not implemented.
- - highlight - {" "} - -{" "} - - - HighlightedFile! - - - Highlight the file.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - disableTimeout - {" "} - -{" "} - - - Boolean! - - -
-
-
-
- - highlightLongLines - {" "} - -{" "} - - - Boolean - - -
-

- If highlightLongLines is true, lines which are - longer than 2000 bytes are highlighted. 2000 - bytes is enabled. This may produce a - significant amount of HTML which some browsers - (such as Chrome, but not Firefox) may have - trouble rendering efficiently. -

-
-
-
- - format - {" "} - -{" "} - - - HighlightResponseFormat - - -
-

- Specifies which format/highlighting technique - to use. -

-
-
-
- - startLine - {" "} - -{" "} - - - Int - - -
-

- Return highlight content starting at line - "startLine". A value <= 0 will be the start - of the file. Warning: Pagination only works - with the HTML_PLAINTEXT format type at the - moment. -

-
-
-
- - endLine - {" "} - -{" "} - - - Int - - -
-

- Return highlight content ending at line - "endLine". A value < 0 or > totalLines - will set endLine to the end of the file. - Warning: Pagination only works with the - HTML_PLAINTEXT format type at the moment. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "path"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "isDirectory"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "content"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "byteSize"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalLines"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "binary"
-                      :{" "}
-                      
-                        false
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "richHTML"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "canonicalURL"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalURLs"
-                      :{" "}
-                      [
-                      ExternalLink
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "highlight"
-                      :{" "}
-                      HighlightedFile
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

Webhook

-
-
-
-
Description
-

Represents an incoming webhook from a code host.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The unique ID of the webhook.
- - uuid - {" "} - -{" "} - - - String! - - - The user facing UUID of the webhook.
- - url - {" "} - -{" "} - - - String! - - - - {" "} - The URL of the webhook in the instance. This is the - location where we expect to receive payloads.{" "} -
- - name - {" "} - -{" "} - - - String! - - - Descriptive webhook name.
- - codeHostKind - {" "} - -{" "} - - - ExternalServiceKind! - - - - {" "} - The kind of code host sending payloads. (eg. GitHub, - GitLab){" "} -
- - codeHostURN - {" "} - -{" "} - - - String! - - - - {" "} - The URN of the code host instance. (eg.{" "} - - https://gitlab.com - ){" "} -
- - secret - {" "} - -{" "} - - - String - - - Optional secret.
- - updatedAt - {" "} - -{" "} - - - DateTime! - - - The last time this webhook was updated.
- - updatedBy - {" "} - -{" "} - - - User - - - - {" "} - The user who last updated this webhook. Null if the - user was deleted or if the webhook hasn't been updated - yet.{" "} -
- - createdAt - {" "} - -{" "} - - - DateTime! - - - When the webhook was created.
- - createdBy - {" "} - -{" "} - - - User - - - - {" "} - The user who created this webhook. Null if the user - was deleted.{" "} -
- - webhookLogs - {" "} - -{" "} - - - WebhookLogConnection! - - - The logs related to this webhook.
-
-
- {" "} - Arguments{" "} -
-
-
-
- - first - {" "} - -{" "} - - - Int - - -
-

Returns the first n webhook logs.

-
-
-
- - after - {" "} - -{" "} - - - String - - -
-

Opaque pagination cursor.

-
-
-
- - onlyErrors - {" "} - -{" "} - - - Boolean - - -
-

- Only include webhook logs that resulted in - errors. -

-
-
-
- - since - {" "} - -{" "} - - - DateTime - - -
-

- Only include webhook logs on or after this - time. -

-
-
-
- - until - {" "} - -{" "} - - - DateTime - - -
-

- Only include webhook logs on or before this - time. -

-
-
-
-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      "4"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "uuid"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "name"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "codeHostKind"
-                      :{" "}
-                      "AWSCODECOMMIT"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "codeHostURN"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "secret"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "updatedBy"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "createdBy"
-                      :{" "}
-                      User
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "webhookLogs"
-                      :{" "}
-                      WebhookLogConnection
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookConnection

-
-
-
-
Description
-

A list of webhooks

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [Webhook!]! - - - A list of webhooks.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of webhooks in the connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      Webhook
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookLog

-
-
-
-
Description
-

A single logged webhook delivery.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - id - {" "} - -{" "} - - - ID! - - - The webhook log ID.
- - receivedAt - {" "} - -{" "} - - - DateTime! - - - The time the webhook was received at.
- - externalService - {" "} - -{" "} - - - ExternalService - - - - {" "} - The external service the webhook was matched to, if - any.{" "} -
- - statusCode - {" "} - -{" "} - - - Int! - - - - {" "} - The HTTP status code returned from the webhook - handler.{" "} -
- - request - {" "} - -{" "} - - - WebhookLogRequest! - - - The received webhook request.
- - response - {" "} - -{" "} - - - WebhookLogResponse! - - - The response sent by the webhook handler.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "id"
-                      :{" "}
-                      4
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "receivedAt"
-                      :{" "}
-                      
-                        "2007-12-03T10:15:30Z"
-                      
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "externalService"
-                      :{" "}
-                      ExternalService
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "statusCode"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "request"
-                      :{" "}
-                      WebhookLogRequest
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "response"
-                      :{" "}
-                      WebhookLogResponse
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookLogConnection

-
-
-
-
Description
-

A list of logged webhook deliveries.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - nodes - {" "} - -{" "} - - - [WebhookLog!]! - - - A list of webhook logs.
- - totalCount - {" "} - -{" "} - - - Int! - - - - {" "} - The total number of webhook logs in the connection.{" "} -
- - pageInfo - {" "} - -{" "} - - - PageInfo! - - - Pagination information.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "nodes"
-                      :{" "}
-                      [
-                      WebhookLog
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "totalCount"
-                      :{" "}
-                      123
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "pageInfo"
-                      :{" "}
-                      PageInfo
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookLogMessage

-
-
-
-
Description
-

- A HTTP message (request or response) within a webhook log. -

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - headers - {" "} - -{" "} - - - [HTTPHeader!]! - - - The headers in the HTTP message.
- - body - {" "} - -{" "} - - - String! - - - The body content of the HTTP message.
-
-
-
Possible Types
- - - - - - - - - - - - - - -
WebhookLogMessage Types
-

- - WebhookLogRequest - -

-
-

- - WebhookLogResponse - -

-
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "headers"
-                      :{" "}
-                      [
-                      HTTPHeader
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "body"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookLogRequest

-
-
-
-
Description
-

A HTTP request within a webhook log.

-
-
-
Fields
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field NameDescription
- - headers - {" "} - -{" "} - - - [HTTPHeader!]! - - - The headers in the HTTP message.
- - body - {" "} - -{" "} - - - String! - - - The body content of the HTTP message.
- - method - {" "} - -{" "} - - - String! - - - The method used in the HTTP request.
- - url - {" "} - -{" "} - - - String! - - - The requested URL.
- - version - {" "} - -{" "} - - - String! - - - The HTTP version in use.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "headers"
-                      :{" "}
-                      [
-                      HTTPHeader
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "body"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "method"
-                      :{" "}
-                      "xyz789"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "url"
-                      :{" "}
-                      "abc123"
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "version"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

WebhookLogResponse

-
-
-
-
Description
-

A HTTP response within a webhook log.

-
-
-
Fields
- - - - - - - - - - - - - - - - - -
Field NameDescription
- - headers - {" "} - -{" "} - - - [HTTPHeader!]! - - - The headers in the HTTP message.
- - body - {" "} - -{" "} - - - String! - - - The body content of the HTTP message.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      {"\n"}
-                      {"  "}
-                      "headers"
-                      :{" "}
-                      [
-                      HTTPHeader
-                      ]
-                      ,
-                      {"\n"}
-                      {"  "}
-                      "body"
-                      :{" "}
-                      "xyz789"
-                      {"\n"}
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
-
-
- Types -
-

repositoryIndexserverHost

-
-
-
-
Description
-

- Information about the indexserver that hosts the repo's - index. -

-
-
-
Fields
- - - - - - - - - - - - - -
Field NameDescription
- - name - {" "} - -{" "} - - - String! - - - The hostname of the indexserver.
-
-
-
-
-
Example
- 
-                    
-                      {"{"}
-                      "name"
-                      :{" "}
-                      "xyz789"
-                      {"}"}
-                      {"\n"}
-                    
-
-
-
-
-
- -
-
-
-
-
- - - -
- -
- - ); -}; - -export default PostLayout;