mirror of
https://github.com/jlengrand/moderne-docs.git
synced 2026-03-10 08:31:21 +00:00
refactor: oh gitbook tables
so limited
This commit is contained in:
Scott Jungling
@@ -2,287 +2,337 @@
|
||||
|
||||
|
||||
## Query
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **accessTokens** : [<a href="#accesstokenview">AccessTokenView</a>!]! | |
|
||||
| **activeRecipeRuns** : [<a href="#reciperun">RecipeRun</a>!]! | Get all currently active recipe runs by a user id (passed via header) sorted by most recent <br/> **Arguments** <ul> <li> **limit**: <a href="#int">Int</a> </li><li> **sortOrder**: <a href="#sortorder">SortOrder</a> </li> </ul> |
|
||||
| **category** : <a href="#recipecategory">RecipeCategory</a>! | Returns a single category with associated `recipes` and `subCategories` <br/> **Arguments** <ul> <li> **categoryId**: <a href="#id">ID</a>! </li> </ul> |
|
||||
| **findRecipes** : [<a href="#recipe">Recipe</a>!]! | Search for recipes by `query` <br/> **Arguments** <ul> <li> **query**: <a href="#string">String</a>! </li> </ul> |
|
||||
| **githubAppInstallationRepositories** : [<a href="#githubappinstallationrepository">GithubAppInstallationRepository</a>!]! | |
|
||||
| **githubAppInstallations** : [<a href="#githubappinstallation">GithubAppInstallation</a>!]! | |
|
||||
| **githubOrganizations** : [<a href="#githuborganization">GithubOrganization</a>!]! | Github Organizations the user belong to, includes public and private <br/> **Arguments** <ul> <li> **name**: <a href="#string">String</a> </li> </ul> |
|
||||
| **githubRepositories** : [<a href="#githubrepository">GithubRepository</a>!]! | Github Repositories owned by the user directly, not an organization |
|
||||
| **previousRecipeRuns** : [<a href="#reciperun">RecipeRun</a>!]! | Get all recipe runs by a user id (passed via header) sorted by most recent <br/> **Arguments** <ul> <li> **limit**: <a href="#int">Int</a> </li><li> **sortOrder**: <a href="#sortorder">SortOrder</a> </li> </ul> |
|
||||
| **recipe** : <a href="#recipe">Recipe</a>! | Look up single recipe record by `id` \n <br/> Example: id: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` <br/> **Arguments** <ul> <li> **id**: <a href="#id">ID</a>! </li> </ul> |
|
||||
| **recipeArtifacts** : [<a href="#recipeartifact">RecipeArtifact</a>!]! | Return all loaded recipe artifacts |
|
||||
| **recipeRun** : <a href="#reciperun">RecipeRun</a>! | |
|
||||
| **recipeRunResults** : <a href="#reciperunresultsbyrepository">RecipeRunResultsByRepository</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. <br/> **Arguments** <ul> <li> **after**: <a href="#string">String</a> </li><li> **first**: <a href="#int">Int</a> </li><li> **id**: <a href="#id">ID</a>! </li><li> **repositoryId**: <a href="#id">ID</a>! </li> </ul> |
|
||||
| **recipeRunResultsByRepository** : <a href="#resultconnection">ResultConnection</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. <br/> **Arguments** <ul> <li> **after**: <a href="#string">String</a> </li><li> **first**: <a href="#int">Int</a> </li><li> **id**: <a href="#id">ID</a>! </li><li> **query**: <a href="#string">String</a> </li><li> **repositoryId**: <a href="#id">ID</a>! </li> </ul> |
|
||||
| **recipeRunSummaryByRepository** : <a href="#reciperunsummary">RecipeRunSummary</a>! | |
|
||||
| **recipes** ⚠️: [<a href="#recipe">Recipe</a>!]! | Returns multiple recipes matching the list of strings provided <br/> @Deprecated -- use recipe(id) instead <br/> <p> use `recipe(id)` instead</p> <br/> **Arguments** <ul> <li> **names**: [<a href="#string">String</a>!]! </li> </ul> |
|
||||
| **repository** : <a href="#repository">Repository</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. <br/> **Arguments** <ul> <li> **id**: <a href="#id">ID</a>! </li> </ul> |
|
||||
| **repositoryIndex** : [<a href="#repositoryindexitem">RepositoryIndexItem</a>!] | Returns the list of known repository identifiers |
|
||||
| **worker** : <a href="#worker">Worker</a> | Look up worker by name <br/> **Arguments** <ul> <li> **name**: <a href="#string">String</a>! </li> </ul> |
|
||||
| **workers** : [<a href="#worker">Worker</a>!]! | Return all known workers |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **accessTokens** | | [<a href="#accesstokenview">AccessTokenView</a>!]! | |
|
||||
| **activeRecipeRuns** | | [<a href="#reciperun">RecipeRun</a>!]! | Get all currently active recipe runs by a user id (passed via header) sorted by most recent |
|
||||
| | `limit` | <a href="#int">Int</a> | |
|
||||
| | `sortOrder` | <a href="#sortorder">SortOrder</a> | |
|
||||
| **category** | | <a href="#recipecategory">RecipeCategory</a>! | Returns a single category with associated `recipes` and `subCategories` |
|
||||
| | `categoryId` | <a href="#id">ID</a>! | |
|
||||
| **findRecipes** | | [<a href="#recipe">Recipe</a>!]! | Search for recipes by `query` |
|
||||
| | `query` | <a href="#string">String</a>! | |
|
||||
| **githubAppInstallationRepositories** | | [<a href="#githubappinstallationrepository">GithubAppInstallationRepository</a>!]! | |
|
||||
| | `installationId` | <a href="#id">ID</a>! | |
|
||||
| **githubAppInstallations** | | [<a href="#githubappinstallation">GithubAppInstallation</a>!]! | |
|
||||
| **githubOrganizations** | | [<a href="#githuborganization">GithubOrganization</a>!]! | Github Organizations the user belong to, includes public and private |
|
||||
| | `name` | <a href="#string">String</a> | Optional name to filter user's organizations by |
|
||||
| **githubRepositories** | | [<a href="#githubrepository">GithubRepository</a>!]! | Github Repositories owned by the user directly, not an organization |
|
||||
| **previousRecipeRuns** | | [<a href="#reciperun">RecipeRun</a>!]! | Get all recipe runs by a user id (passed via header) sorted by most recent |
|
||||
| | `limit` | <a href="#int">Int</a> | |
|
||||
| | `sortOrder` | <a href="#sortorder">SortOrder</a> | |
|
||||
| **recipe** | | <a href="#recipe">Recipe</a>! | Look up single recipe record by `id` \n <br/> Example: id: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| **recipeArtifacts** | | [<a href="#recipeartifact">RecipeArtifact</a>!]! | Return all loaded recipe artifacts |
|
||||
| **recipeRun** | | <a href="#reciperun">RecipeRun</a>! | |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| **recipeRunResults** | | <a href="#reciperunresultsbyrepository">RecipeRunResultsByRepository</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. |
|
||||
| | `after` | <a href="#string">String</a> | |
|
||||
| | `first` | <a href="#int">Int</a> | |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| | `repositoryId` | <a href="#id">ID</a>! | |
|
||||
| **recipeRunResultsByRepository** | | <a href="#resultconnection">ResultConnection</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. |
|
||||
| | `after` | <a href="#string">String</a> | |
|
||||
| | `first` | <a href="#int">Int</a> | |
|
||||
| | `id` | <a href="#id">ID</a>! | Run ID |
|
||||
| | `query` | <a href="#string">String</a> | |
|
||||
| | `repositoryId` | <a href="#id">ID</a>! | Example: `Netflix:eureka` |
|
||||
| **recipeRunSummaryByRepository** | | <a href="#reciperunsummary">RecipeRunSummary</a>! | |
|
||||
| | `id` | <a href="#id">ID</a>! | Recipe Run ID |
|
||||
| | `repositoryId` | <a href="#id">ID</a>! | Example: `Netflix:eureka` |
|
||||
| **recipes** ⚠️ | | [<a href="#recipe">Recipe</a>!]! | Returns multiple recipes matching the list of strings provided <br/> @Deprecated -- use recipe(id) instead <br/> <p> use `recipe(id)` instead</p> |
|
||||
| | `names` | [<a href="#string">String</a>!]! | |
|
||||
| **repository** | | <a href="#repository">Repository</a>! | This query is only apart of MRE for the purposes of schema composition <br/> Queries will be handled directly by a worker. |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| **repositoryIndex** | | [<a href="#repositoryindexitem">RepositoryIndexItem</a>!] | Returns the list of known repository identifiers |
|
||||
| **worker** | | <a href="#worker">Worker</a> | Look up worker by name |
|
||||
| | `name` | <a href="#string">String</a>! | |
|
||||
| **workers** | | [<a href="#worker">Worker</a>!]! | Return all known workers |
|
||||
|
||||
## Mutation
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **addIngestToGithubRepository** : <a href="#string">String</a>! | |
|
||||
| **cancelRecipeRun** : <a href="#id">ID</a>! | |
|
||||
| **commitToBranch** : <a href="#branchresponse">BranchResponse</a>! | |
|
||||
| **createAccessToken** : <a href="#string">String</a>! | |
|
||||
| **createBranchFromResult** : <a href="#branchresponse">BranchResponse</a>! | |
|
||||
| **deleteAccessToken** : <a href="#boolean">Boolean</a>! | |
|
||||
| **loadRecipes** : <a href="#recipeartifact">RecipeArtifact</a> | |
|
||||
| **runRecipe** : <a href="#reciperun">RecipeRun</a>! | |
|
||||
| **runYamlRecipe** : <a href="#reciperun">RecipeRun</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **addIngestToGithubRepository** | | <a href="#string">String</a>! | |
|
||||
| | `installationId` | <a href="#string">String</a>! | |
|
||||
| | `repositoryName` | <a href="#string">String</a>! | |
|
||||
| | `repositoryOwner` | <a href="#string">String</a>! | |
|
||||
| **cancelRecipeRun** | | <a href="#id">ID</a>! | |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| **commitToBranch** | | <a href="#branchresponse">BranchResponse</a>! | |
|
||||
| | `branchName` | <a href="#string">String</a>! | |
|
||||
| | `commit` | <a href="#string">String</a>! | |
|
||||
| | `commitMessage` | <a href="#string">String</a>! | |
|
||||
| | `recipeRunId` | <a href="#id">ID</a>! | |
|
||||
| | `repositoryId` | <a href="#id">ID</a>! | |
|
||||
| | `resultsLink` | <a href="#string">String</a>! | |
|
||||
| **createAccessToken** | | <a href="#string">String</a>! | |
|
||||
| | `description` | <a href="#string">String</a> | |
|
||||
| **createBranchFromResult** | | <a href="#branchresponse">BranchResponse</a>! | |
|
||||
| | `branchName` | <a href="#string">String</a>! | |
|
||||
| | `commit` | <a href="#string">String</a>! | |
|
||||
| | `commitMessage` | <a href="#string">String</a>! | |
|
||||
| | `fork` | <a href="#boolean">Boolean</a>! | |
|
||||
| | `recipeRunId` | <a href="#id">ID</a>! | |
|
||||
| | `repositoryId` | <a href="#id">ID</a>! | |
|
||||
| | `resultsLink` | <a href="#string">String</a>! | |
|
||||
| **deleteAccessToken** | | <a href="#boolean">Boolean</a>! | |
|
||||
| | `id` | <a href="#id">ID</a>! | |
|
||||
| **loadRecipes** | | <a href="#recipeartifact">RecipeArtifact</a> | |
|
||||
| | `artifactId` | <a href="#string">String</a>! | |
|
||||
| | `datedSnapshotVersion` | <a href="#string">String</a> | |
|
||||
| | `groupId` | <a href="#string">String</a>! | |
|
||||
| | `version` | <a href="#string">String</a>! | |
|
||||
| **runRecipe** | | <a href="#reciperun">RecipeRun</a>! | |
|
||||
| | `run` | <a href="#reciperuninput">RecipeRunInput</a>! | |
|
||||
| **runYamlRecipe** | | <a href="#reciperun">RecipeRun</a>! | |
|
||||
| | `repositoryFilter` | [<a href="#id">ID</a>!] | |
|
||||
| | `yaml` | <a href="#string">String</a>! | |
|
||||
|
||||
## Objects
|
||||
|
||||
### AccessTokenView
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **created** : <a href="#datetime">DateTime</a>! | |
|
||||
| **description** : <a href="#string">String</a> | |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **created** | | <a href="#datetime">DateTime</a>! | |
|
||||
| **description** | | <a href="#string">String</a> | |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
|
||||
### BranchResponse
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **branchName** : <a href="#string">String</a>! | |
|
||||
| **commit** : <a href="#string">String</a>! | Commit SHA |
|
||||
| **repository** : <a href="#githubrepository">GithubRepository</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **branchName** | | <a href="#string">String</a>! | |
|
||||
| **commit** | | <a href="#string">String</a>! | Commit SHA |
|
||||
| **repository** | | <a href="#githubrepository">GithubRepository</a>! | |
|
||||
|
||||
### Commit
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **branch** : <a href="#string">String</a>! | |
|
||||
| **changeset** : <a href="#string">String</a>! | Git SHA |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **branch** | | <a href="#string">String</a>! | |
|
||||
| **changeset** | | <a href="#string">String</a>! | Git SHA |
|
||||
|
||||
### GithubAppInstallation
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **accountLogin** : <a href="#string">String</a>! | |
|
||||
| **accountType** : <a href="#githubaccounttype">GithubAccountType</a>! | |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **repositories** : [<a href="#githubappinstallationrepository">GithubAppInstallationRepository</a>!]! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **accountLogin** | | <a href="#string">String</a>! | |
|
||||
| **accountType** | | <a href="#githubaccounttype">GithubAccountType</a>! | |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **repositories** | | [<a href="#githubappinstallationrepository">GithubAppInstallationRepository</a>!]! | |
|
||||
|
||||
### GithubAppInstallationRepository
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **hasWorkflowInstalled** : <a href="#boolean">Boolean</a>! | |
|
||||
| **isWorkflowRunInProgress** : <a href="#boolean">Boolean</a>! | |
|
||||
| **lastWorkflowRunAt** : <a href="#datetime">DateTime</a> | |
|
||||
| **repository** : <a href="#githubrepository">GithubRepository</a>! | |
|
||||
| **wasLastWorkflowRunSuccessful** : <a href="#boolean">Boolean</a> | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **hasWorkflowInstalled** | | <a href="#boolean">Boolean</a>! | |
|
||||
| **isWorkflowRunInProgress** | | <a href="#boolean">Boolean</a>! | |
|
||||
| **lastWorkflowRunAt** | | <a href="#datetime">DateTime</a> | |
|
||||
| **repository** | | <a href="#githubrepository">GithubRepository</a>! | |
|
||||
| **wasLastWorkflowRunSuccessful** | | <a href="#boolean">Boolean</a> | |
|
||||
|
||||
### GithubOrganization
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| **repositories** : [<a href="#githubrepository">GithubRepository</a>!]! | |
|
||||
| **url** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
| **repositories** | | [<a href="#githubrepository">GithubRepository</a>!]! | |
|
||||
| **url** | | <a href="#string">String</a>! | |
|
||||
|
||||
### GithubRepository
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **defaultBranch** : <a href="#string">String</a>! | |
|
||||
| **fullName** : <a href="#string">String</a>! | |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| **privateRepo** : <a href="#boolean">Boolean</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **defaultBranch** | | <a href="#string">String</a>! | |
|
||||
| **fullName** | | <a href="#string">String</a>! | |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
| **privateRepo** | | <a href="#boolean">Boolean</a>! | |
|
||||
|
||||
### GithubUserAccessTokenResponse
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **accessToken** : <a href="#string">String</a>! | |
|
||||
| **refreshToken** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **accessToken** | | <a href="#string">String</a>! | |
|
||||
| **refreshToken** | | <a href="#string">String</a>! | |
|
||||
|
||||
### Option
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **description** : <a href="#string">String</a>! | |
|
||||
| **displayName** : <a href="#string">String</a>! | |
|
||||
| **example** : <a href="#string">String</a> | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| **required** : <a href="#boolean">Boolean</a>! | |
|
||||
| **type** : <a href="#string">String</a>! | |
|
||||
| **valid** : [<a href="#string">String</a>] | |
|
||||
| **value** : <a href="#object">Object</a> | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **description** | | <a href="#string">String</a>! | |
|
||||
| **displayName** | | <a href="#string">String</a>! | |
|
||||
| **example** | | <a href="#string">String</a> | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
| **required** | | <a href="#boolean">Boolean</a>! | |
|
||||
| **type** | | <a href="#string">String</a>! | |
|
||||
| **valid** | | [<a href="#string">String</a>] | |
|
||||
| **value** | | <a href="#object">Object</a> | |
|
||||
|
||||
### Organization
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
|
||||
### Page
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **endCursor** : <a href="#string">String</a>! | |
|
||||
| **hasNextPage** : <a href="#boolean">Boolean</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **endCursor** | | <a href="#string">String</a>! | |
|
||||
| **hasNextPage** | | <a href="#boolean">Boolean</a>! | |
|
||||
|
||||
### Recipe
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **description** : <a href="#string">String</a> | Note: May contain markdown formatting <br/> @markdown |
|
||||
| **id** : <a href="#id">ID</a>! | Example: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` |
|
||||
| **languages** : [<a href="#string">String</a>!]! | |
|
||||
| **name** : <a href="#string">String</a>! | Note: May contain markdown formatting <br/> @markdown |
|
||||
| **options** : [<a href="#option">Option</a>!]! | |
|
||||
| **recipeArtifact** : <a href="#recipeartifact">RecipeArtifact</a> | |
|
||||
| **recipeList** : [<a href="#recipe">Recipe</a>!]! | |
|
||||
| **tags** : [<a href="#string">String</a>!]! | |
|
||||
| **totalRecipes** : <a href="#int">Int</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **description** | | <a href="#string">String</a> | Note: May contain markdown formatting <br/> @markdown |
|
||||
| **id** | | <a href="#id">ID</a>! | Example: `org.openrewrite.java.testing.junit5.IgnoreToDisabled` |
|
||||
| **languages** | | [<a href="#string">String</a>!]! | |
|
||||
| **name** | | <a href="#string">String</a>! | Note: May contain markdown formatting <br/> @markdown |
|
||||
| **options** | | [<a href="#option">Option</a>!]! | |
|
||||
| **recipeArtifact** | | <a href="#recipeartifact">RecipeArtifact</a> | |
|
||||
| **recipeList** | | [<a href="#recipe">Recipe</a>!]! | |
|
||||
| **tags** | | [<a href="#string">String</a>!]! | |
|
||||
| **totalRecipes** | | <a href="#int">Int</a>! | |
|
||||
|
||||
### RecipeArtifact
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **artifactId** : <a href="#string">String</a>! | |
|
||||
| **datedSnapshotVersion** : <a href="#string">String</a> | |
|
||||
| **groupId** : <a href="#string">String</a>! | |
|
||||
| **repositoryUrl** : <a href="#string">String</a> | |
|
||||
| **requestedVersion** : <a href="#string">String</a>! | |
|
||||
| **snapshotTime** : <a href="#datetime">DateTime</a> | The time from datedSnapshotVersion extracted into a DateTime <br/> for human readable presentation in time zones other than UTC |
|
||||
| **version** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **artifactId** | | <a href="#string">String</a>! | |
|
||||
| **datedSnapshotVersion** | | <a href="#string">String</a> | |
|
||||
| **groupId** | | <a href="#string">String</a>! | |
|
||||
| **repositoryUrl** | | <a href="#string">String</a> | |
|
||||
| **requestedVersion** | | <a href="#string">String</a>! | |
|
||||
| **snapshotTime** | | <a href="#datetime">DateTime</a> | The time from datedSnapshotVersion extracted into a DateTime <br/> for human readable presentation in time zones other than UTC |
|
||||
| **version** | | <a href="#string">String</a>! | |
|
||||
|
||||
### RecipeCategory
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **breadcrumbs** : [<a href="#recipecategorybreadcrumb">RecipeCategoryBreadcrumb</a>!]! | |
|
||||
| **description** : <a href="#string">String</a> | @markdown |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | Captialization handled in services. <br/> Text transformation by client not required <br/> @markdown |
|
||||
| **recipes** : [<a href="#recipe">Recipe</a>!]! | |
|
||||
| **subCategories** : [<a href="#recipecategory">RecipeCategory</a>!]! | Sorted alphabetically by `RecipeCategory.name` |
|
||||
| **tags** : [<a href="#string">String</a>!]! | |
|
||||
| **totalRecipeCount** : <a href="#int">Int</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **breadcrumbs** | | [<a href="#recipecategorybreadcrumb">RecipeCategoryBreadcrumb</a>!]! | |
|
||||
| **description** | | <a href="#string">String</a> | @markdown |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | Captialization handled in services. <br/> Text transformation by client not required <br/> @markdown |
|
||||
| **recipes** | | [<a href="#recipe">Recipe</a>!]! | |
|
||||
| **subCategories** | | [<a href="#recipecategory">RecipeCategory</a>!]! | Sorted alphabetically by `RecipeCategory.name` |
|
||||
| **tags** | | [<a href="#string">String</a>!]! | |
|
||||
| **totalRecipeCount** | | <a href="#int">Int</a>! | |
|
||||
|
||||
### RecipeCategoryBreadcrumb
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
|
||||
### RecipeRun
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **recipe** : <a href="#recipe">Recipe</a>! | |
|
||||
| **repositoryFilter** : [<a href="#id">ID</a>!]! | |
|
||||
| **start** : <a href="#datetime">DateTime</a>! | |
|
||||
| **state** : <a href="#reciperunstate">RecipeRunState</a>! | |
|
||||
| **summaryResults** : [<a href="#reciperunsummary">RecipeRunSummary</a>!]! | Sorted alphabetically by Repository ID |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **recipe** | | <a href="#recipe">Recipe</a>! | |
|
||||
| **repositoryFilter** | | [<a href="#id">ID</a>!]! | |
|
||||
| **start** | | <a href="#datetime">DateTime</a>! | |
|
||||
| **state** | | <a href="#reciperunstate">RecipeRunState</a>! | |
|
||||
| **summaryResults** | | [<a href="#reciperunsummary">RecipeRunSummary</a>!]! | Sorted alphabetically by Repository ID |
|
||||
|
||||
### RecipeRunResultsByRepository
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **commit** : <a href="#commit">Commit</a>! | |
|
||||
| **patchLink** : <a href="#string">String</a> | |
|
||||
| **results** : <a href="#resultconnection">ResultConnection</a>! | |
|
||||
| **totalResults** : <a href="#int">Int</a>! | |
|
||||
| **totalSearched** : <a href="#int">Int</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **commit** | | <a href="#commit">Commit</a>! | |
|
||||
| **patchLink** | | <a href="#string">String</a> | |
|
||||
| **results** | | <a href="#resultconnection">ResultConnection</a>! | |
|
||||
| **totalResults** | | <a href="#int">Int</a>! | |
|
||||
| **totalSearched** | | <a href="#int">Int</a>! | |
|
||||
|
||||
### RecipeRunSummary
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **commit** : <a href="#commit">Commit</a>! | |
|
||||
| **lastUpdated** : <a href="#datetime">DateTime</a>! | |
|
||||
| **repositoryId** : <a href="#id">ID</a>! | |
|
||||
| **resultsLink** : <a href="#string">String</a> | The GraphQL endpoint that you can execute a RecipeRunResultsByRepository. <br/> When a worker is in Moderne's VPC, the API gateway serves as a redirect to <br/> the worker node. <br/> <br/> @see https://api.moderne.io/worker/results?worker=abc123 |
|
||||
| **runId** : <a href="#id">ID</a>! | |
|
||||
| **state** : <a href="#reciperunsummarystate">RecipeRunSummaryState</a>! | |
|
||||
| **stateMessage** : <a href="#string">String</a> | |
|
||||
| **totalResults** : <a href="#int">Int</a>! | |
|
||||
| **totalSearched** : <a href="#int">Int</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **commit** | | <a href="#commit">Commit</a>! | |
|
||||
| **lastUpdated** | | <a href="#datetime">DateTime</a>! | |
|
||||
| **repositoryId** | | <a href="#id">ID</a>! | |
|
||||
| **resultsLink** | | <a href="#string">String</a> | The GraphQL endpoint that you can execute a RecipeRunResultsByRepository. <br/> When a worker is in Moderne's VPC, the API gateway serves as a redirect to <br/> the worker node. <br/> <br/> @see https://api.moderne.io/worker/results?worker=abc123 |
|
||||
| **runId** | | <a href="#id">ID</a>! | |
|
||||
| **state** | | <a href="#reciperunsummarystate">RecipeRunSummaryState</a>! | |
|
||||
| **stateMessage** | | <a href="#string">String</a> | |
|
||||
| **totalResults** | | <a href="#int">Int</a>! | |
|
||||
| **totalSearched** | | <a href="#int">Int</a>! | |
|
||||
|
||||
### Repository
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **commit** : <a href="#commit">Commit</a>! | |
|
||||
| **id** : <a href="#id">ID</a>! | Example: `netflix:eureka` |
|
||||
| **ingested** : <a href="#datetime">DateTime</a>! | Example: `2021-05-13T11:56:29.818228-07:00` |
|
||||
| **javaVersion** : <a href="#repositoryjavaversion">RepositoryJavaVersion</a> | |
|
||||
| **name** : <a href="#string">String</a>! | Example: `eureka` |
|
||||
| **organization** : <a href="#organization">Organization</a>! | Example: `netflix` |
|
||||
| **sourceFilesByType** : [<a href="#sourcefiletypecount">SourceFileTypeCount</a>!]! | Example: {"fileType": "java", "count": 1392} |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **commit** | | <a href="#commit">Commit</a>! | |
|
||||
| **id** | | <a href="#id">ID</a>! | Example: `netflix:eureka` |
|
||||
| **ingested** | | <a href="#datetime">DateTime</a>! | Example: `2021-05-13T11:56:29.818228-07:00` |
|
||||
| **javaVersion** | | <a href="#repositoryjavaversion">RepositoryJavaVersion</a> | |
|
||||
| **name** | | <a href="#string">String</a>! | Example: `eureka` |
|
||||
| **organization** | | <a href="#organization">Organization</a>! | Example: `netflix` |
|
||||
| **sourceFilesByType** | | [<a href="#sourcefiletypecount">SourceFileTypeCount</a>!]! | Example: {"fileType": "java", "count": 1392} |
|
||||
|
||||
### RepositoryIndexItem
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | |
|
||||
| **link** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | |
|
||||
| **link** | | <a href="#string">String</a>! | |
|
||||
|
||||
### RepositoryJavaVersion
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **createdBy** : <a href="#string">String</a>! | |
|
||||
| **sourceCompatibility** : <a href="#string">String</a>! | |
|
||||
| **targetCompatibility** : <a href="#string">String</a>! | |
|
||||
| **vmVendor** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **createdBy** | | <a href="#string">String</a>! | |
|
||||
| **sourceCompatibility** | | <a href="#string">String</a>! | |
|
||||
| **targetCompatibility** | | <a href="#string">String</a>! | |
|
||||
| **vmVendor** | | <a href="#string">String</a>! | |
|
||||
|
||||
### Result
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **after** : <a href="#string">String</a>! | |
|
||||
| **afterSourcePath** : <a href="#string">String</a>! | |
|
||||
| **before** : <a href="#string">String</a>! | |
|
||||
| **beforeSourcePath** : <a href="#string">String</a>! | |
|
||||
| **diff** : <a href="#string">String</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **after** | | <a href="#string">String</a>! | |
|
||||
| **afterSourcePath** | | <a href="#string">String</a>! | |
|
||||
| **before** | | <a href="#string">String</a>! | |
|
||||
| **beforeSourcePath** | | <a href="#string">String</a>! | |
|
||||
| **diff** | | <a href="#string">String</a>! | |
|
||||
|
||||
### ResultConnection
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **edges** : [<a href="#resultedge">ResultEdge</a>!]! | |
|
||||
| **pageInfo** : <a href="#page">Page</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **edges** | | [<a href="#resultedge">ResultEdge</a>!]! | |
|
||||
| **pageInfo** | | <a href="#page">Page</a>! | |
|
||||
|
||||
### ResultEdge
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **cursor** : <a href="#string">String</a>! | |
|
||||
| **node** : <a href="#result">Result</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **cursor** | | <a href="#string">String</a>! | |
|
||||
| **node** | | <a href="#result">Result</a>! | |
|
||||
|
||||
### SourceFileTypeCount
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **count** : <a href="#int">Int</a>! | Example: 1392 |
|
||||
| **fileType** : <a href="#string">String</a>! | Example: `java` |
|
||||
| **linesOfCode** : <a href="#int">Int</a>! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **count** | | <a href="#int">Int</a>! | Example: 1392 |
|
||||
| **fileType** | | <a href="#string">String</a>! | Example: `java` |
|
||||
| **linesOfCode** | | <a href="#int">Int</a>! | |
|
||||
|
||||
### Worker
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **connectedSince** : <a href="#datetime">DateTime</a>! | |
|
||||
| **name** : <a href="#string">String</a>! | |
|
||||
| **repositories** : [<a href="#string">String</a>!]! | |
|
||||
| Field | Argument | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **connectedSince** | | <a href="#datetime">DateTime</a>! | |
|
||||
| **name** | | <a href="#string">String</a>! | |
|
||||
| **repositories** | | [<a href="#string">String</a>!]! | |
|
||||
|
||||
## Inputs
|
||||
|
||||
@@ -290,24 +340,24 @@
|
||||
|
||||
Recipe option input value type depends on the particular recipe
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **name** : <a href="#string">String</a>! | Example: `methodPattern` |
|
||||
| **value** : <a href="#object">Object</a>! | Example: `java.util.List add(..)` |
|
||||
| Field | | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **name** | | <a href="#string">String</a>! | Example: `methodPattern` |
|
||||
| **value** | | <a href="#object">Object</a>! | Example: `java.util.List add(..)` |
|
||||
|
||||
### RecipeInput
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **id** : <a href="#id">ID</a>! | Example: `org.openrewrite.java.search.FindMethods` |
|
||||
| **options** : [<a href="#optioninput">OptionInput</a>!] | |
|
||||
| Field | | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **id** | | <a href="#id">ID</a>! | Example: `org.openrewrite.java.search.FindMethods` |
|
||||
| **options** | | [<a href="#optioninput">OptionInput</a>!] | |
|
||||
|
||||
### RecipeRunInput
|
||||
|
||||
| Field | Description |
|
||||
| ---- | ---- |
|
||||
| **recipe** : <a href="#recipeinput">RecipeInput</a>! | |
|
||||
| **repositoryFilter** : [<a href="#id">ID</a>!] | Send `null` to run on all repositories. <br/> Example: `airbnb:epoxy` |
|
||||
| Field | | Type | Description |
|
||||
| ---- | ---- | ---- | ---- |
|
||||
| **recipe** | | <a href="#recipeinput">RecipeInput</a>! | |
|
||||
| **repositoryFilter** | | [<a href="#id">ID</a>!] | Send `null` to run on all repositories. <br/> Example: `airbnb:epoxy` |
|
||||
|
||||
## Enums
|
||||
|
||||
|
||||
Reference in New Issue
Block a user