From 6ccdb9c45b630b51a398ee315b652fe79f977107 Mon Sep 17 00:00:00 2001 From: Greg Adams Date: Sat, 2 Oct 2021 19:07:55 +0000 Subject: [PATCH] GitBook: [main] 2 pages modified --- how-to/on-premise-agent.md | 4 +- references/api-schema.md | 2903 +++++------------------------------- 2 files changed, 411 insertions(+), 2496 deletions(-) diff --git a/how-to/on-premise-agent.md b/how-to/on-premise-agent.md index 6930b5cd..124cb27f 100644 --- a/how-to/on-premise-agent.md +++ b/how-to/on-premise-agent.md @@ -23,7 +23,9 @@ The Moderne agent fetches secret configuration from Vault. It reads from a KV se ### Run the agent container -The Moderne on-premise agent is available via [Docker Hub](https://hub.docker.com/repository/docker/moderne/agent). Several environment variables are required +The Moderne on-premise agent is available as an OCI image. Contact Moderne to obtain access. + +The container requires several environment variables: * MODERNE\_API\_GATEWAY_\__RSOCKET_\__URI - URI used to connect to the Moderne API, provided by Moderne * MODERNE\_AGENT_\__ARTIFACTORY\_URL - Artifactory URL diff --git a/references/api-schema.md b/references/api-schema.md index 82001927..e5a6a3e3 100644 --- a/references/api-schema.md +++ b/references/api-schema.md @@ -1,2653 +1,567 @@ -# Moderne.io GraphQL API - +# GraphQL API documentation ## Query - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
accessTokens[AccessTokenView!]!
activeRecipeRuns[RecipeRun!]! -Get all currently active recipes by a user id (passed via header); sorted by most recent. - -
limitInt
sortOrderSortOrder
allowedUsers[String!]!
categoryRecipeCategory! - -Returns a single category with associated `recipes` and `subCategories`. - -
categoryIdID!
eventsEventConnection!
afterString
firstInt
findRecipes[Recipe!]! - -Search for recipes matching the supplied search query. - -
queryString!
githubApiTokenExistsBoolean!
githubAppInstallationRepositories[GithubAppInstallationRepository!]!
installationIdID!
githubAppInstallations[GithubAppInstallation!]!
previousRecipeRunsRecipeRunConnection! - -Get all recipe runs by a user id (passed via header) sorted by most recent. - -
afterString
firstInt
sortOrderSortOrder
quarantinedRepositories[RepositoryIndexItem!]
recipeRecipe! - -Look up a single recipe record by it's fully-qualified `ID`. \n -Example: `id`: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` - -
idID!
recipeArtifacts[RecipeArtifact!]! - -Return all loaded recipe artifacts - -
recipeRunRecipeRun!
idID!
recipeRunResultsRecipeRunResultsByRepository! - -This query is only a part of Recipe Execution for schema composition. -Queries are handled directly by a worker. - -
afterString
firstInt
idID!
repositoryIdID!
recipeRunResultsByRepositoryResultConnection! - -This query is only a part of Recipe Execution for schema composition -Queries are handled directly by a worker. - -
afterString
firstInt
idID! - -Run ID - -
queryString
repositoryIdID! - -Example: `Netflix:eureka` - -
recipeRunSummaryByRepositoryRecipeRunSummary!
idID! - -Recipe Run ID - -
repositoryIdID! - -Example: `Netflix:eureka` - -
recipes ⚠️[Recipe!]! -

⚠️ DEPRECATED

-
- -use `recipe(id)` instead - -
-
names[String!]!
repositoryRepository! - -This query is only a part of Recipe Execution for schema composition -Queries are handled directly by a worker. - -
idID!
repositoryIndex[RepositoryIndexItem!] - -Returns the list of known repository identifiers - -
sourceFilesChanged[SourceFile!]
commitString!
originString!
userAllowedBoolean!
usernameString!
userHasAccessToRepositoryBoolean! - -Does the current user have access to the repositoryId? - -
repositoryIdString!
workerWorker
nameString!
workers[Worker!]! - -This query returns a list of all active worker nodes processing recipes. - -
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **accessTokens** | \[[AccessTokenView](api-schema.md#accesstokenview)!\]! | | | +| **activeRecipeRuns** | \[[RecipeRun](api-schema.md#reciperun)!\]! | Get all currently active recipes by a user id \(passed via header\); sorted by most recent. | | +| limit | [Int](api-schema.md#int) | | | +| sortOrder | [SortOrder](api-schema.md#sortorder) | | | +| **allowedUsers** | \[[String](api-schema.md#string)!\]! | | | +| **category** | [RecipeCategory](api-schema.md#recipecategory)! | Returns a single category with associated \`recipes\` and \`subCategories\`. | | +| categoryId | [ID](api-schema.md#id)! | | | +| **events** | [EventConnection](api-schema.md#eventconnection)! | | | +| after | [String](api-schema.md#string) | | | +| first | [Int](api-schema.md#int) | | | +| **findRecipes** | \[[Recipe](api-schema.md#recipe)!\]! | Search for recipes matching the supplied search query. | | +| query | [String](api-schema.md#string)! | | | +| **githubApiTokenExists** | [Boolean](api-schema.md#boolean)! | | | +| **githubAppInstallationRepositories** | \[[GithubAppInstallationRepository](api-schema.md#githubappinstallationrepository)!\]! | | | +| installationId | [ID](api-schema.md#id)! | | | +| **githubAppInstallations** | \[[GithubAppInstallation](api-schema.md#githubappinstallation)!\]! | | | +| **previousRecipeRuns** | [RecipeRunConnection](api-schema.md#reciperunconnection)! | Get all recipe runs by a user id \(passed via header\) sorted by most recent. | | +| after | [String](api-schema.md#string) | | | +| first | [Int](api-schema.md#int) | | | +| sortOrder | [SortOrder](api-schema.md#sortorder) | | | +| **quarantinedRepositories** | \[[RepositoryIndexItem](api-schema.md#repositoryindexitem)!\] | | | +| **recipe** | [Recipe](api-schema.md#recipe)! | Look up a single recipe record by it's fully-qualified \`ID\`. \n Example: \`id\`: \`org.openrewrite.java.testing.junit5.IgnoreToDisabled\` | | +| id | [ID](api-schema.md#id)! | | | +| **recipeArtifacts** | \[[RecipeArtifact](api-schema.md#recipeartifact)!\]! | Return all loaded recipe artifacts | | +| **recipeRun** | [RecipeRun](api-schema.md#reciperun)! | | | +| id | [ID](api-schema.md#id)! | | | +| **recipeRunResults** | [RecipeRunResultsByRepository](api-schema.md#reciperunresultsbyrepository)! | This query is only a part of Recipe Execution for schema composition. Queries are handled directly by a worker. | | +| after | [String](api-schema.md#string) | | | +| first | [Int](api-schema.md#int) | | | +| id | [ID](api-schema.md#id)! | | | +| repositoryId | [ID](api-schema.md#id)! | | | +| **recipeRunResultsByRepository** | [ResultConnection](api-schema.md#resultconnection)! | This query is only a part of Recipe Execution for schema composition Queries are handled directly by a worker. | | +| after | [String](api-schema.md#string) | | | +| first | [Int](api-schema.md#int) | | | +| id | [ID](api-schema.md#id)! | Run ID | | +| query | [String](api-schema.md#string) | | | +| repositoryId | [ID](api-schema.md#id)! | Example: \`Netflix:eureka\` | | +| **recipeRunSummaryByRepository** | [RecipeRunSummary](api-schema.md#reciperunsummary)! | | | +| id | [ID](api-schema.md#id)! | Recipe Run ID | | +| repositoryId | [ID](api-schema.md#id)! | Example: \`Netflix:eureka\` | | +| **recipes** ⚠️ | \[[Recipe](api-schema.md#recipe)!\]! | ⚠️ **DEPRECATED** | | +| names | \[[String](api-schema.md#string)!\]! | | | +| **repository** | [Repository](api-schema.md#repository)! | This query is only a part of Recipe Execution for schema composition Queries are handled directly by a worker. | | +| id | [ID](api-schema.md#id)! | | | +| **repositoryIndex** | \[[RepositoryIndexItem](api-schema.md#repositoryindexitem)!\] | Returns the list of known repository identifiers | | +| **sourceFilesChanged** | \[[SourceFile](api-schema.md#sourcefile)!\] | | | +| commit | [String](api-schema.md#string)! | | | +| origin | [String](api-schema.md#string)! | | | +| **userAllowed** | [Boolean](api-schema.md#boolean)! | | | +| username | [String](api-schema.md#string)! | | | +| **userHasAccessToRepository** | [Boolean](api-schema.md#boolean)! | Does the current user have access to the repositoryId? | | +| repositoryId | [String](api-schema.md#string)! | | | +| **worker** | [Worker](api-schema.md#worker) | | | +| name | [String](api-schema.md#string)! | | | +| **workers** | \[[Worker](api-schema.md#worker)!\]! | This query returns a list of all active worker nodes processing recipes. | | ## Mutation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
addAllowedUserBoolean!
usernameString!
addIngestToGithubRepositoryString!
installationIdString!
repositoryNameString!
repositoryOwnerString!
cancelRecipeRunID!
idID!
commitToBranchBranchResponse!
branchNameString!
commitString!
commitMessageString!
recipeRunIdID!
repositoryIdID!
resultsLinkString!
createAccessTokenString!
descriptionString
createBranchFromResultBranchResponse!
branchNameString!
commitString!
commitMessageString!
forkBoolean!
recipeRunIdID!
repositoryIdID!
resultsLinkString!
deleteAccessTokenBoolean!
idID!
deleteAllowedUserBoolean!
usernameString!
deleteGitHubApiTokenBoolean!
exchangeGithubAuthorizationCodeBoolean! -Exchanges a GitHub OAuth access code into an access token. - -Successful exchanged tokens are stored for future use. - -@see https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow - -
codeString! - -Temporary code returned from GitHub from Step 1 of the OAuth web application flow. - -
redirectUriString! - -Valid redirect URI for the associated GitHub OAuth app. - -
loadRecipesRecipeArtifact
artifactIdString!
datedSnapshotVersionString
groupIdString!
versionString!
quarantineRepositoryRepository - -When a repository routinely errors or causes instability, it can be quarantined, making it -effectively invisible to the service until it is un-quarantined - -
idID!
runAdHocPolyglotRecipeRecipeRun!
inputAdHocRecipeRunInput!
runRecipeRecipeRun!
runRecipeRunInput!
runYamlRecipeRecipeRun!
repositoryFilter[ID!]
yamlBase64!
unquarantineRepositoryRepository
idID!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **addAllowedUser** | [Boolean](api-schema.md#boolean)! | | | +| username | [String](api-schema.md#string)! | | | +| **addIngestToGithubRepository** | [String](api-schema.md#string)! | | | +| installationId | [String](api-schema.md#string)! | | | +| repositoryName | [String](api-schema.md#string)! | | | +| repositoryOwner | [String](api-schema.md#string)! | | | +| **cancelRecipeRun** | [ID](api-schema.md#id)! | | | +| id | [ID](api-schema.md#id)! | | | +| **commitToBranch** | [BranchResponse](api-schema.md#branchresponse)! | | | +| branchName | [String](api-schema.md#string)! | | | +| commit | [String](api-schema.md#string)! | | | +| commitMessage | [String](api-schema.md#string)! | | | +| recipeRunId | [ID](api-schema.md#id)! | | | +| repositoryId | [ID](api-schema.md#id)! | | | +| resultsLink | [String](api-schema.md#string)! | | | +| **createAccessToken** | [String](api-schema.md#string)! | | | +| description | [String](api-schema.md#string) | | | +| **createBranchFromResult** | [BranchResponse](api-schema.md#branchresponse)! | | | +| branchName | [String](api-schema.md#string)! | | | +| commit | [String](api-schema.md#string)! | | | +| commitMessage | [String](api-schema.md#string)! | | | +| fork | [Boolean](api-schema.md#boolean)! | | | +| recipeRunId | [ID](api-schema.md#id)! | | | +| repositoryId | [ID](api-schema.md#id)! | | | +| resultsLink | [String](api-schema.md#string)! | | | +| **deleteAccessToken** | [Boolean](api-schema.md#boolean)! | | | +| id | [ID](api-schema.md#id)! | | | +| **deleteAllowedUser** | [Boolean](api-schema.md#boolean)! | | | +| username | [String](api-schema.md#string)! | | | +| **deleteGitHubApiToken** | [Boolean](api-schema.md#boolean)! | | | +| **exchangeGithubAuthorizationCode** | [Boolean](api-schema.md#boolean)! | Exchanges a GitHub OAuth access code into an access token. Successful exchanged tokens are stored for future use. @see https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps\#web-application-flow | | +| code | [String](api-schema.md#string)! | Temporary code returned from GitHub from Step 1 of the OAuth web application flow. | | +| redirectUri | [String](api-schema.md#string)! | Valid redirect URI for the associated GitHub OAuth app. | | +| **loadRecipes** | [RecipeArtifact](api-schema.md#recipeartifact) | | | +| artifactId | [String](api-schema.md#string)! | | | +| datedSnapshotVersion | [String](api-schema.md#string) | | | +| groupId | [String](api-schema.md#string)! | | | +| version | [String](api-schema.md#string)! | | | +| **quarantineRepository** | [Repository](api-schema.md#repository) | When a repository routinely errors or causes instability, it can be quarantined, making it effectively invisible to the service until it is un-quarantined | | +| id | [ID](api-schema.md#id)! | | | +| **runAdHocPolyglotRecipe** | [RecipeRun](api-schema.md#reciperun)! | | | +| input | [AdHocRecipeRunInput](api-schema.md#adhocreciperuninput)! | | | +| **runRecipe** | [RecipeRun](api-schema.md#reciperun)! | | | +| run | [RecipeRunInput](api-schema.md#reciperuninput)! | | | +| **runYamlRecipe** | [RecipeRun](api-schema.md#reciperun)! | | | +| repositoryFilter | \[[ID](api-schema.md#id)!\] | | | +| yaml | [Base64](api-schema.md#base64)! | | | +| **unquarantineRepository** | [Repository](api-schema.md#repository) | | | +| id | [ID](api-schema.md#id)! | | | ## Objects ### AccessTokenView - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
createdDateTime!
descriptionString
idID!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **created** | [DateTime](api-schema.md#datetime)! | | | +| **description** | [String](api-schema.md#string) | | | +| **id** | [ID](api-schema.md#id)! | | | ### BranchResponse - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
branchNameString!
commitString! - -Commit SHA - -
repositoryGithubRepository!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **branchName** | [String](api-schema.md#string)! | | | +| **commit** | [String](api-schema.md#string)! | Commit SHA | | +| **repository** | [GithubRepository](api-schema.md#githubrepository)! | | | ### Commit - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
branchString!
changesetString! - -Git SHA - -
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **branch** | [String](api-schema.md#string)! | | | +| **changeset** | [String](api-schema.md#string)! | Git SHA | | ### Event - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
actionString!
actionTypeActionType!
descriptionString!
targetString!
timestampDateTime!
userIdString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **action** | [String](api-schema.md#string)! | | | +| **actionType** | [ActionType](api-schema.md#actiontype)! | | | +| **description** | [String](api-schema.md#string)! | | | +| **target** | [String](api-schema.md#string)! | | | +| **timestamp** | [DateTime](api-schema.md#datetime)! | | | +| **userId** | [String](api-schema.md#string)! | | | ### EventConnection - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
edges[EventEdge!]!
pageInfoPage!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **edges** | \[[EventEdge](api-schema.md#eventedge)!\]! | | | +| **pageInfo** | [Page](api-schema.md#page)! | | | ### EventEdge - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
cursorString!
nodeEvent!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **cursor** | [String](api-schema.md#string)! | | | +| **node** | [Event](api-schema.md#event)! | | | ### GithubAppInstallation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
accountLoginString!
accountTypeGithubAccountType!
idID!
repositories[GithubAppInstallationRepository!]!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **accountLogin** | [String](api-schema.md#string)! | | | +| **accountType** | [GithubAccountType](api-schema.md#githubaccounttype)! | | | +| **id** | [ID](api-schema.md#id)! | | | +| **repositories** | \[[GithubAppInstallationRepository](api-schema.md#githubappinstallationrepository)!\]! | | | ### GithubAppInstallationRepository - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
hasWorkflowInstalledBoolean!
isWorkflowRunInProgressBoolean!
lastWorkflowRunAtDateTime
repositoryGithubRepository!
wasLastWorkflowRunSuccessfulBoolean
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **hasWorkflowInstalled** | [Boolean](api-schema.md#boolean)! | | | +| **isWorkflowRunInProgress** | [Boolean](api-schema.md#boolean)! | | | +| **lastWorkflowRunAt** | [DateTime](api-schema.md#datetime) | | | +| **repository** | [GithubRepository](api-schema.md#githubrepository)! | | | +| **wasLastWorkflowRunSuccessful** | [Boolean](api-schema.md#boolean) | | | ### GithubOrganization - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID!
nameString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | | +| **name** | [String](api-schema.md#string)! | | | ### GithubRepository - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
defaultBranchString!
fullNameString!
idID!
nameString!
privateRepoBoolean!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **defaultBranch** | [String](api-schema.md#string)! | | | +| **fullName** | [String](api-schema.md#string)! | | | +| **id** | [ID](api-schema.md#id)! | | | +| **name** | [String](api-schema.md#string)! | | | +| **privateRepo** | [Boolean](api-schema.md#boolean)! | | | ### GithubUserAccessTokenResponse - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
accessTokenString!
refreshTokenString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **accessToken** | [String](api-schema.md#string)! | | | +| **refreshToken** | [String](api-schema.md#string)! | | | ### Option - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
descriptionString!
displayNameString!
exampleString
nameString!
requiredBoolean!
typeString!
valid[String]
valueObject
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **description** | [String](api-schema.md#string)! | | | +| **displayName** | [String](api-schema.md#string)! | | | +| **example** | [String](api-schema.md#string) | | | +| **name** | [String](api-schema.md#string)! | | | +| **required** | [Boolean](api-schema.md#boolean)! | | | +| **type** | [String](api-schema.md#string)! | | | +| **valid** | \[[String](api-schema.md#string)\] | | | +| **value** | [Object](api-schema.md#object) | | | ### Organization - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID!
nameString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | | +| **name** | [String](api-schema.md#string)! | | | ### Page - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
endCursorString!
hasNextPageBoolean!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **endCursor** | [String](api-schema.md#string)! | | | +| **hasNextPage** | [Boolean](api-schema.md#boolean)! | | | ### PageInfo - Pagination Type - Generic +Pagination Type - Generic - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
endCursorString
hasNextPageBoolean!
hasPreviousPageBoolean!
startCursorString
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **endCursor** | [String](api-schema.md#string) | | | +| **hasNextPage** | [Boolean](api-schema.md#boolean)! | | | +| **hasPreviousPage** | [Boolean](api-schema.md#boolean)! | | | +| **startCursor** | [String](api-schema.md#string) | | | ### Recipe - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
descriptionString - -Note: May contain markdown formatting -@markdown - -
idID! - -Example: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` - -
languages[String!]!
nameString! - -Note: May contain markdown formatting -@markdown - -
options[Option!]!
recipeArtifactRecipeArtifact
recipeList[Recipe!]!
tags[String!]!
totalRecipesInt!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **description** | [String](api-schema.md#string) | Note: May contain markdown formatting @markdown | | +| **id** | [ID](api-schema.md#id)! | Example: \`org.openrewrite.java.testing.junit5.IgnoreToDisabled\` | | +| **languages** | \[[String](api-schema.md#string)!\]! | | | +| **name** | [String](api-schema.md#string)! | Note: May contain markdown formatting @markdown | | +| **options** | \[[Option](api-schema.md#option)!\]! | | | +| **recipeArtifact** | [RecipeArtifact](api-schema.md#recipeartifact) | | | +| **recipeList** | \[[Recipe](api-schema.md#recipe)!\]! | | | +| **tags** | \[[String](api-schema.md#string)!\]! | | | +| **totalRecipes** | [Int](api-schema.md#int)! | | | ### RecipeArtifact - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
artifactIdString!
datedSnapshotVersionString
groupIdString!
repositoryUrlString
requestedVersionString!
snapshotTimeDateTime - -The time from datedSnapshotVersion extracted into a DateTime -for human-readable presentation in time zones other than UTC - -
versionString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **artifactId** | [String](api-schema.md#string)! | | | +| **datedSnapshotVersion** | [String](api-schema.md#string) | | | +| **groupId** | [String](api-schema.md#string)! | | | +| **repositoryUrl** | [String](api-schema.md#string) | | | +| **requestedVersion** | [String](api-schema.md#string)! | | | +| **snapshotTime** | [DateTime](api-schema.md#datetime) | The time from datedSnapshotVersion extracted into a DateTime for human-readable presentation in time zones other than UTC | | +| **version** | [String](api-schema.md#string)! | | | ### RecipeCategory - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
breadcrumbs[RecipeCategoryBreadcrumb!]!
descriptionString - -@markdown - -
idID!
nameString! - -Services handle capitalization of `name`. -Clients are responsible for parsing and formatting Markdown to HTML -@markdown - -
recipes[Recipe!]!
subCategories[RecipeCategory!]! - -Categories are sorted alphabetically by `RecipeCategory.name`. - -
tags[String!]!
totalRecipeCountInt!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **breadcrumbs** | \[[RecipeCategoryBreadcrumb](api-schema.md#recipecategorybreadcrumb)!\]! | | | +| **description** | [String](api-schema.md#string) | @markdown | | +| **id** | [ID](api-schema.md#id)! | | | +| **name** | [String](api-schema.md#string)! | Services handle capitalization of \`name\`. Clients are responsible for parsing and formatting Markdown to HTML @markdown | | +| **recipes** | \[[Recipe](api-schema.md#recipe)!\]! | | | +| **subCategories** | \[[RecipeCategory](api-schema.md#recipecategory)!\]! | Categories are sorted alphabetically by \`RecipeCategory.name\`. | | +| **tags** | \[[String](api-schema.md#string)!\]! | | | +| **totalRecipeCount** | [Int](api-schema.md#int)! | | | ### RecipeCategoryBreadcrumb - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID!
nameString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | | +| **name** | [String](api-schema.md#string)! | | | ### RecipeRun - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID!
recipeRecipe!
repositoryFilter[ID!]!
startDateTime!
stateRecipeRunState!
summaryResults[RecipeRunSummary!]! - -Sorted alphabetically by Repository ID - -
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | | +| **recipe** | [Recipe](api-schema.md#recipe)! | | | +| **repositoryFilter** | \[[ID](api-schema.md#id)!\]! | | | +| **start** | [DateTime](api-schema.md#datetime)! | | | +| **state** | [RecipeRunState](api-schema.md#reciperunstate)! | | | +| **summaryResults** | \[[RecipeRunSummary](api-schema.md#reciperunsummary)!\]! | Sorted alphabetically by Repository ID | | ### RecipeRunConnection - Pagination Types - Recipe Run History +Pagination Types - Recipe Run History - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
edges[RecipeRunEdge]
pageInfoPageInfo
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **edges** | \[[RecipeRunEdge](api-schema.md#reciperunedge)\] | | | +| **pageInfo** | [PageInfo](api-schema.md#pageinfo) | | | ### RecipeRunEdge - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
cursorString
nodeRecipeRun
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **cursor** | [String](api-schema.md#string) | | | +| **node** | [RecipeRun](api-schema.md#reciperun) | | | ### RecipeRunResultsByRepository - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
commitCommit!
patchLinkString
resultsResultConnection!
totalResultsInt!
totalSearchedInt!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **commit** | [Commit](api-schema.md#commit)! | | | +| **patchLink** | [String](api-schema.md#string) | | | +| **results** | [ResultConnection](api-schema.md#resultconnection)! | | | +| **totalResults** | [Int](api-schema.md#int)! | | | +| **totalSearched** | [Int](api-schema.md#int)! | | | ### RecipeRunSummary - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
commitCommit!
lastUpdatedDateTime!
repositoryIdID!
resultsLinkString - -The GraphQL endpoint that you can execute a `RecipeRunResultsByRepository`. -When a worker is in Moderne's VPC, the API gateway redirects to the worker node. - -@see https://api.moderne.io/worker/results?worker=abc123 - -
runIdID!
stateRecipeRunSummaryState!
stateMessageString
timeSavingsDuration
totalResultsInt!
totalSearchedInt!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **commit** | [Commit](api-schema.md#commit)! | | | +| **lastUpdated** | [DateTime](api-schema.md#datetime)! | | | +| **repositoryId** | [ID](api-schema.md#id)! | | | +| **resultsLink** | [String](api-schema.md#string) | The GraphQL endpoint that you can execute a \`RecipeRunResultsByRepository\`. When a worker is in Moderne's VPC, the API gateway redirects to the worker node. @see https://api.moderne.io/worker/results?worker=abc123 | | +| **runId** | [ID](api-schema.md#id)! | | | +| **state** | [RecipeRunSummaryState](api-schema.md#reciperunsummarystate)! | | | +| **stateMessage** | [String](api-schema.md#string) | | | +| **timeSavings** | [Duration](api-schema.md#duration) | | | +| **totalResults** | [Int](api-schema.md#int)! | | | +| **totalSearched** | [Int](api-schema.md#int)! | | | ### Repository - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
commitCommit!
idID! - -Example: `netflix:eureka` - -
ingestedDateTime! - -Example: `2021-05-13T11:56:29.818228-07:00` - -
javaVersionRepositoryJavaVersion
nameString! - -Example: `eureka` - -
organizationOrganization! - -Example: `netflix` - -
sourceFilesByType[SourceFileTypeCount!]!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **commit** | [Commit](api-schema.md#commit)! | | | +| **id** | [ID](api-schema.md#id)! | Example: \`netflix:eureka\` | | +| **ingested** | [DateTime](api-schema.md#datetime)! | Example: \`2021-05-13T11:56:29.818228-07:00\` | | +| **javaVersion** | [RepositoryJavaVersion](api-schema.md#repositoryjavaversion) | | | +| **name** | [String](api-schema.md#string)! | Example: \`eureka\` | | +| **organization** | [Organization](api-schema.md#organization)! | Example: \`netflix\` | | +| **sourceFilesByType** | \[[SourceFileTypeCount](api-schema.md#sourcefiletypecount)!\]! | | | ### RepositoryIndexItem - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
idID!
linkString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | | +| **link** | [String](api-schema.md#string)! | | | ### RepositoryJavaVersion - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
createdByString!
sourceCompatibilityString!
targetCompatibilityString!
vmVendorString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **createdBy** | [String](api-schema.md#string)! | | | +| **sourceCompatibility** | [String](api-schema.md#string)! | | | +| **targetCompatibility** | [String](api-schema.md#string)! | | | +| **vmVendor** | [String](api-schema.md#string)! | | | ### Result - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
afterString!
afterSourcePathString!
beforeString!
beforeSourcePathString!
diffString!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **after** | [String](api-schema.md#string)! | | | +| **afterSourcePath** | [String](api-schema.md#string)! | | | +| **before** | [String](api-schema.md#string)! | | | +| **beforeSourcePath** | [String](api-schema.md#string)! | | | +| **diff** | [String](api-schema.md#string)! | | | ### ResultConnection - Pagination Types - Results +Pagination Types - Results - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
edges[ResultEdge]
pageInfoPageInfo
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **edges** | \[[ResultEdge](api-schema.md#resultedge)\] | | | +| **pageInfo** | [PageInfo](api-schema.md#pageinfo) | | | ### ResultEdge - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
cursorString!
nodeResult!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **cursor** | [String](api-schema.md#string)! | | | +| **node** | [Result](api-schema.md#result)! | | | ### SourceFile - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
sourceBase64!
sourcePathPath!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **source** | [Base64](api-schema.md#base64)! | | | +| **sourcePath** | [Path](api-schema.md#path)! | | | ### SourceFileTypeCount - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
countInt! - -`count` represents the number of files of this type. - -
fileTypeString! - -Example: `java` - -
linesOfCodeInt! - -Cumulative count of lines across all the files of this type. - -
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **count** | [Int](api-schema.md#int)! | \`count\` represents the number of files of this type. | | +| **fileType** | [String](api-schema.md#string)! | Example: \`java\` | | +| **linesOfCode** | [Int](api-schema.md#int)! | Cumulative count of lines across all the files of this type. | | ### Worker - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldArgumentTypeDescription
connectedSinceDateTime!
nameString!
repositories[String!]!
+| Field | Argument | Type | Description | +| :--- | :--- | :--- | :--- | +| **connectedSince** | [DateTime](api-schema.md#datetime)! | | | +| **name** | [String](api-schema.md#string)! | | | +| **repositories** | \[[String](api-schema.md#string)!\]! | | | ## Inputs ### AdHocRecipeInput - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idID!
nameString!
options[OptionInput!]
sourceBase64!
sourceNameString!
sourcePathString!
+| Field | Type | Description | +| :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | | +| **name** | [String](api-schema.md#string)! | | +| **options** | \[[OptionInput](api-schema.md#optioninput)!\] | | +| **source** | [Base64](api-schema.md#base64)! | | +| **sourceName** | [String](api-schema.md#string)! | | +| **sourcePath** | [String](api-schema.md#string)! | | ### AdHocRecipeRunInput - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
partialRepositoryPartialRepositoryInput
recipeAdHocRecipeInput!
repositoryFilter[ID!] - -Send `null` to run on all repositories. -Example: `airbnb:epoxy` - -
+| Field | Type | Description | +| :--- | :--- | :--- | +| **partialRepository** | [PartialRepositoryInput](api-schema.md#partialrepositoryinput) | | +| **recipe** | [AdHocRecipeInput](api-schema.md#adhocrecipeinput)! | | +| **repositoryFilter** | \[[ID](api-schema.md#id)!\] | Send \`null\` to run on all repositories. Example: \`airbnb:epoxy\` | ### CommitInput - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
branchString!
changesetString! - -Git SHA - -
originString! - -SSH or HTTPS URL to the repository - -
+| Field | Type | Description | +| :--- | :--- | :--- | +| **branch** | [String](api-schema.md#string)! | | +| **changeset** | [String](api-schema.md#string)! | Git SHA | +| **origin** | [String](api-schema.md#string)! | SSH or HTTPS URL to the repository | ### OptionInput - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
nameString! - -Example: `methodPattern` - -
valueObject! - -Example: `java.util.List add(..)` - -
+| Field | Type | Description | +| :--- | :--- | :--- | +| **name** | [String](api-schema.md#string)! | Example: \`methodPattern\` | +| **value** | [Object](api-schema.md#object)! | Example: \`java.util.List add\(..\)\` | ### PartialRepositoryInput - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
commitCommitInput!
idString!
sourceFiles[SourceFileInput!]!
+| Field | Type | Description | +| :--- | :--- | :--- | +| **commit** | [CommitInput](api-schema.md#commitinput)! | | +| **id** | [String](api-schema.md#string)! | | +| **sourceFiles** | \[[SourceFileInput](api-schema.md#sourcefileinput)!\]! | | ### RecipeInput - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
idID! - -Example: `org.openrewrite.java.search.FindMethods` - -
options[OptionInput!]
+| Field | Type | Description | +| :--- | :--- | :--- | +| **id** | [ID](api-schema.md#id)! | Example: \`org.openrewrite.java.search.FindMethods\` | +| **options** | \[[OptionInput](api-schema.md#optioninput)!\] | | ### RecipeRunInput - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
partialRepositoryPartialRepositoryInput
recipeRecipeInput!
repositoryFilter[ID!] - -Send `null` to run on all repositories. -Example: `airbnb:epoxy` - -
+| Field | Type | Description | +| :--- | :--- | :--- | +| **partialRepository** | [PartialRepositoryInput](api-schema.md#partialrepositoryinput) | | +| **recipe** | [RecipeInput](api-schema.md#recipeinput)! | | +| **repositoryFilter** | \[[ID](api-schema.md#id)!\] | Send \`null\` to run on all repositories. Example: \`airbnb:epoxy\` | ### SourceFileInput - - - - - - - - - - - - - - - - - - - - -
FieldTypeDescription
sourceBase64!
sourcePathPath!
+| Field | Type | Description | +| :--- | :--- | :--- | +| **source** | [Base64](api-schema.md#base64)! | | +| **sourcePath** | [Path](api-schema.md#path)! | | ## Enums ### ActionType - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
Create
Delete
Read
Update
+| Value | Description | +| :--- | :--- | +| **Create** | | +| **Delete** | | +| **Read** | | +| **Update** | | ### ErrorDetail - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
DEADLINE_EXCEEDED - -The deadline expired before the operation could complete. - -For operations that change the state of the system, this error -may be returned even if the operation has completed successfully. -For example, a successful response from a server could have been -delayed long enough for the deadline to expire. - -HTTP Mapping: 504 Gateway Timeout -Error Type: UNAVAILABLE - -
ENHANCE_YOUR_CALM - -The server detected that the client is exhibiting a behavior that -might be generating excessive load. - -HTTP Mapping: 429 Too Many Requests or 420 Enhance Your Calm -Error Type: UNAVAILABLE - -
FIELD_NOT_FOUND - -The requested field is not found in the schema. - -This differs from `NOT_FOUND` in that `NOT_FOUND` should be used when a -query is valid, but is unable to return a result (if, for example, a -specific video id doesn't exist). `FIELD_NOT_FOUND` is intended to be -returned by the server to signify that the requested field is not known to exist. -This may be returned in lieu of failing the entire query. -See also `PERMISSION_DENIED` for cases where the -requested field is invalid only for the given user or class of users. - -HTTP Mapping: 404 Not Found -Error Type: BAD_REQUEST - -
INVALID_ARGUMENT - -The client specified an invalid argument. - -Note that this differs from `FAILED_PRECONDITION`. -`INVALID_ARGUMENT` indicates arguments that are problematic -regardless of the state of the system (e.g., a malformed file name). - -HTTP Mapping: 400 Bad Request -Error Type: BAD_REQUEST - -
INVALID_CURSOR - -The provided cursor is not valid. - -The most common usage for this error is when a client is paginating -through a list that uses stateful cursors. In that case, the provided -cursor may be expired. - -HTTP Mapping: 404 Not Found -Error Type: NOT_FOUND - -
MISSING_RESOURCE - -Unable to perform operation because a required resource is missing. - -Example: Client is attempting to refresh a list, but the specified -list is expired. This requires an action by the client to get a new list. - -If the user is simply trying GET a resource that is not found, -use the NOT_FOUND error type. FAILED_PRECONDITION.MISSING_RESOURCE -is to be used particularly when the user is performing an operation -that requires a particular resource to exist. - -HTTP Mapping: 400 Bad Request or 500 Internal Server Error -Error Type: FAILED_PRECONDITION - -
SERVICE_ERROR - -Service Error. - -There is a problem with an upstream service. - -This may be returned if a gateway receives an unknown error from a service -or if a service is unreachable. -If a request times out which waiting on a response from a service, -`DEADLINE_EXCEEDED` may be returned instead. -If a service returns a more specific error Type, the specific error Type may -be returned instead. - -HTTP Mapping: 502 Bad Gateway -Error Type: UNAVAILABLE - -
TCP_FAILURE - -Request failed due to network errors. - -HTTP Mapping: 503 Unavailable -Error Type: UNAVAILABLE - -
THROTTLED_CONCURRENCY - -Request throttled based on server concurrency limits. - -HTTP Mapping: 503 Unavailable -Error Type: UNAVAILABLE - -
THROTTLED_CPU - -Request throttled based on server CPU limits - -HTTP Mapping: 503 Unavailable. -Error Type: UNAVAILABLE - -
UNIMPLEMENTED - -The operation is not implemented or is not currently supported/enabled. - -HTTP Mapping: 501 Not Implemented -Error Type: BAD_REQUEST - -
UNKNOWN - -Unknown error. - -This error should only be returned when no other error detail applies. -If a client sees an unknown errorDetail, it will be interpreted as UNKNOWN. - -HTTP Mapping: 500 Internal Server Error - -
+| Value | Description | +| :--- | :--- | +| **DEADLINE\_EXCEEDED** | The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout Error Type: UNAVAILABLE | +| **ENHANCE\_YOUR\_CALM** | The server detected that the client is exhibiting a behavior that might be generating excessive load. HTTP Mapping: 429 Too Many Requests or 420 Enhance Your Calm Error Type: UNAVAILABLE | +| **FIELD\_NOT\_FOUND** | The requested field is not found in the schema. This differs from \`NOT\_FOUND\` in that \`NOT\_FOUND\` should be used when a query is valid, but is unable to return a result \(if, for example, a specific video id doesn't exist\). \`FIELD\_NOT\_FOUND\` is intended to be returned by the server to signify that the requested field is not known to exist. This may be returned in lieu of failing the entire query. See also \`PERMISSION\_DENIED\` for cases where the requested field is invalid only for the given user or class of users. HTTP Mapping: 404 Not Found Error Type: BAD\_REQUEST | +| **INVALID\_ARGUMENT** | The client specified an invalid argument. Note that this differs from \`FAILED\_PRECONDITION\`. \`INVALID\_ARGUMENT\` indicates arguments that are problematic regardless of the state of the system \(e.g., a malformed file name\). HTTP Mapping: 400 Bad Request Error Type: BAD\_REQUEST | +| **INVALID\_CURSOR** | The provided cursor is not valid. The most common usage for this error is when a client is paginating through a list that uses stateful cursors. In that case, the provided cursor may be expired. HTTP Mapping: 404 Not Found Error Type: NOT\_FOUND | +| **MISSING\_RESOURCE** | Unable to perform operation because a required resource is missing. Example: Client is attempting to refresh a list, but the specified list is expired. This requires an action by the client to get a new list. If the user is simply trying GET a resource that is not found, use the NOT\_FOUND error type. FAILED\_PRECONDITION.MISSING\_RESOURCE is to be used particularly when the user is performing an operation that requires a particular resource to exist. HTTP Mapping: 400 Bad Request or 500 Internal Server Error Error Type: FAILED\_PRECONDITION | +| **SERVICE\_ERROR** | Service Error. There is a problem with an upstream service. This may be returned if a gateway receives an unknown error from a service or if a service is unreachable. If a request times out which waiting on a response from a service, \`DEADLINE\_EXCEEDED\` may be returned instead. If a service returns a more specific error Type, the specific error Type may be returned instead. HTTP Mapping: 502 Bad Gateway Error Type: UNAVAILABLE | +| **TCP\_FAILURE** | Request failed due to network errors. HTTP Mapping: 503 Unavailable Error Type: UNAVAILABLE | +| **THROTTLED\_CONCURRENCY** | Request throttled based on server concurrency limits. HTTP Mapping: 503 Unavailable Error Type: UNAVAILABLE | +| **THROTTLED\_CPU** | Request throttled based on server CPU limits HTTP Mapping: 503 Unavailable. Error Type: UNAVAILABLE | +| **UNIMPLEMENTED** | The operation is not implemented or is not currently supported/enabled. HTTP Mapping: 501 Not Implemented Error Type: BAD\_REQUEST | +| **UNKNOWN** | Unknown error. This error should only be returned when no other error detail applies. If a client sees an unknown errorDetail, it will be interpreted as UNKNOWN. HTTP Mapping: 500 Internal Server Error | ### ErrorType - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
BAD_REQUEST - -Bad Request. - -There is a problem with the request. -Retrying the same request is not likely to succeed. -An example would be a query or argument that cannot be deserialized. - -HTTP Mapping: 400 Bad Request - -
FAILED_PRECONDITION - -The operation was rejected because the system is not in a state -required for the operation's execution. For example, the directory -to be deleted is non-empty, an rmdir operation is applied to -a non-directory, etc. - -Service implementers can use the following guidelines to decide -between `FAILED_PRECONDITION` and `UNAVAILABLE`: - -- Use `UNAVAILABLE` if the client can retry just the failing call. -- Use `FAILED_PRECONDITION` if the client should not retry until -the system state has been explicitly fixed. E.g., if an "rmdir" - fails because the directory is non-empty, `FAILED_PRECONDITION` -should be returned since the client should not retry unless -the files are deleted from the directory. - -HTTP Mapping: 400 Bad Request or 500 Internal Server Error - -
INTERNAL - -Internal error. - -An unexpected internal error was encountered. This means that some -invariants expected by the underlying system have been broken. -This error code is reserved for serious errors. - -HTTP Mapping: 500 Internal Server Error - -
NOT_FOUND - -The requested entity was not found. - -This could apply to a resource that has never existed (e.g. bad resource id), -or a resource that no longer exists (e.g. cache expired.) - -Note to server developers: if a request is denied for an entire class -of users, such as gradual feature rollout or undocumented allowlist, -`NOT_FOUND` may be used. If a request is denied for some users within -a class of users, such as user-based access control, `PERMISSION_DENIED` -must be used. - -HTTP Mapping: 404 Not Found - -
PERMISSION_DENIED - -The caller does not have permission to execute the specified -operation. - -`PERMISSION_DENIED` must not be used for rejections -caused by exhausting some resource or quota. -`PERMISSION_DENIED` must not be used if the caller -cannot be identified (use `UNAUTHENTICATED` -instead for those errors). - -This error Type does not imply the -request is valid or the requested entity exists or satisfies -other pre-conditions. - -HTTP Mapping: 403 Forbidden - -
UNAUTHENTICATED - -The request does not have valid authentication credentials. - -This is intended to be returned only for routes that require -authentication. - -HTTP Mapping: 401 Unauthorized - -
UNAVAILABLE - -Currently Unavailable. - -The service is currently unavailable. This is most likely a -transient condition, which can be corrected by retrying with -a backoff. - -HTTP Mapping: 503 Unavailable - -
UNKNOWN - -Unknown error. - -For example, this error may be returned when -an error code received from another address space belongs to -an error space that is not known in this address space. Also -errors raised by APIs that do not return enough error information -may be converted to this error. - -If a client sees an unknown errorType, it will be interpreted as UNKNOWN. -Unknown errors MUST NOT trigger any special behavior. These MAY be treated -by an implementation as being equivalent to INTERNAL. - -When possible, a more specific error should be provided. - -HTTP Mapping: 520 Unknown Error - -
+| Value | Description | +| :--- | :--- | +| **BAD\_REQUEST** | Bad Request. There is a problem with the request. Retrying the same request is not likely to succeed. An example would be a query or argument that cannot be deserialized. HTTP Mapping: 400 Bad Request | +| **FAILED\_PRECONDITION** | The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementers can use the following guidelines to decide between \`FAILED\_PRECONDITION\` and \`UNAVAILABLE\`: - Use \`UNAVAILABLE\` if the client can retry just the failing call. - Use \`FAILED\_PRECONDITION\` if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, \`FAILED\_PRECONDITION\` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request or 500 Internal Server Error | +| **INTERNAL** | Internal error. An unexpected internal error was encountered. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error | +| **NOT\_FOUND** | The requested entity was not found. This could apply to a resource that has never existed \(e.g. bad resource id\), or a resource that no longer exists \(e.g. cache expired.\) Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, \`NOT\_FOUND\` may be used. If a request is denied for some users within a class of users, such as user-based access control, \`PERMISSION\_DENIED\` must be used. HTTP Mapping: 404 Not Found | +| **PERMISSION\_DENIED** | The caller does not have permission to execute the specified operation. \`PERMISSION\_DENIED\` must not be used for rejections caused by exhausting some resource or quota. \`PERMISSION\_DENIED\` must not be used if the caller cannot be identified \(use \`UNAUTHENTICATED\` instead for those errors\). This error Type does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden | +| **UNAUTHENTICATED** | The request does not have valid authentication credentials. This is intended to be returned only for routes that require authentication. HTTP Mapping: 401 Unauthorized | +| **UNAVAILABLE** | Currently Unavailable. The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. HTTP Mapping: 503 Unavailable | +| **UNKNOWN** | Unknown error. For example, this error may be returned when an error code received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. If a client sees an unknown errorType, it will be interpreted as UNKNOWN. Unknown errors MUST NOT trigger any special behavior. These MAY be treated by an implementation as being equivalent to INTERNAL. When possible, a more specific error should be provided. HTTP Mapping: 520 Unknown Error | ### GithubAccountType - - - - - - - - - - - - - - - -
ValueDescription
Organization
User
+| Value | Description | +| :--- | :--- | +| **Organization** | | +| **User** | | ### RecipeRunState - - - - - - - - - - - - - - - - - - - -
ValueDescription
CANCELED
FINISHED
RUNNING
+| Value | Description | +| :--- | :--- | +| **CANCELED** | | +| **FINISHED** | | +| **RUNNING** | | ### RecipeRunSummaryState - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
CANCELED
CREATED
ERROR - -A worker was unable to process this recipe. - -
FINISHED
LOADING - -A repository's Abstract Syntax Tree is loading into a worker. - -
QUEUED - -A repository is waiting for open workers to process the recipe. - -
RUNNING
TIMEOUT - -A worker was unable to process this recipe in a reasonable amount of time. - -
UNAVAILABLE - -A worker was unavailable to process this recipe. - -
+| Value | Description | +| :--- | :--- | +| **CANCELED** | | +| **CREATED** | | +| **ERROR** | A worker was unable to process this recipe. | +| **FINISHED** | | +| **LOADING** | A repository's Abstract Syntax Tree is loading into a worker. | +| **QUEUED** | A repository is waiting for open workers to process the recipe. | +| **RUNNING** | | +| **TIMEOUT** | A worker was unable to process this recipe in a reasonable amount of time. | +| **UNAVAILABLE** | A worker was unavailable to process this recipe. | ### SortOrder - - - - - - - - - - - - - - - -
ValueDescription
ASC
DESC
+| Value | Description | +| :--- | :--- | +| **ASC** | | +| **DESC** | | ## Scalars @@ -2661,16 +575,15 @@ The `Boolean` scalar type represents `true` or `false`. ### Duration -String in ISO-8601. -Example: `PT10S` -> 10 seconds +String in ISO-8601. Example: `PT10S` -> 10 seconds ### ID -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. +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. ### Int -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. +The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -\(2^31\) and 2^31 - 1. ### Object