jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: rough-in how to access api docs

Browse Source
This commit is contained in:
Scott Jungling
2022-01-13 15:59:35 -08:00
parent af60cc9299
commit cad0fa7efe
11 changed files with 41 additions and 631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/account-settings-menu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

BIN
.gitbook/assets/account-settings-page-token.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 99 KiB

BIN
.gitbook/assets/graphql-playground-docs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 212 KiB

BIN
.gitbook/assets/graphql-playground.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

26
SUMMARY.md
View File

@@ -1,28 +1,26 @@
# Table of contents
* [Welcome to Moderne](README.md)
- [Welcome to Moderne](README.md)
## Getting Started
* [Quick Start: Running your first recipe](getting-started/running-your-first-recipe.md)
- [Quick Start: Running your first recipe](getting-started/running-your-first-recipe.md)
## How-to Guides <a id="how-to"></a>
* [Creating your own recipes with Builder](how-to/creating-your-own-recipes-with-builder.md)
* [Importing projects from GitHub](how-to/importing-projects-from-github.md)
* [Integrating private code with Moderne SaaS](how-to/integrating-private-code.md)
* [Importing external recipes](how-to/importing-external-recipes.md)
* [Terraform Cloud integration](how-to/terraform-cloud-integration.md)
* [On-Premise Agent](how-to/on-premise-agent.md)
- [Creating your own recipes with Builder](how-to/creating-your-own-recipes-with-builder.md)
- [Importing projects from GitHub](how-to/importing-projects-from-github.md)
- [Integrating private code with Moderne SaaS](how-to/integrating-private-code.md)
- [Importing external recipes](how-to/importing-external-recipes.md)
- [Terraform Cloud integration](how-to/terraform-cloud-integration.md)
- [On-Premise Agent](how-to/on-premise-agent.md)
- [Accessing the Moderne API](how-to/accessing-the-moderne-api.md)
## References
* [Repository selection](references/repository-selection.md)
* [GitHub permissions](references/github-permissions.md)
* [Token management](references/create-api-access-tokens.md)
* [GraphQL API documentation](references/api-schema.md)
- [GitHub permissions](references/github-permissions.md)
- [Token management](references/create-api-access-tokens.md)
## Legal
* [Terms of Service](legal/terms-of-service.md)
- [Terms of Service](legal/terms-of-service.md)

3
graphql-api.md
View File

@@ -1,3 +0,0 @@
# GraphQL API
Moderne.io offers a GraphQL API [https://api.moderne.io](https://api.moderne.io) that customers can interact with using their Personal Access Token

24
how-to/accessing-the-moderne-api.md Normal file
View File

@@ -0,0 +1,24 @@
# Accessing the Moderne API
Moderne.io offers a GraphQL API [https://api.moderne.io](https://api.moderne.io) for customers to interact with through the usage of a personal access token.
## Prerequisites
- Create a [Moderne Personal Access Token](../references/create-api-access-tokens.md)
## Go to the Moderne API
- [https://api.moderne.io](https://api.moderne.io)
## Configure your access token
In the `HTTP Headers` pane of GraphQL Playground, enter in your token for the `Authorization` header.
![authorization header](../.gitbook/assets/graphql-playground.png)
## (Optional) View the Documentation
After you have configured your personal access token, you can click the _Docs_ tab on the right-hand side of the screen to explore the various Queries and Mutations offered by the API.
![api docs](../.gitbook/assets/graphql-playground-docs.png)
## 🚀 Start Querying!

3
how-to/importing-external-recipes.md
View File

@@ -2,6 +2,8 @@
External recipes can be imported into Moderne.io for use by your organization.
This requires an Administrator-level account in order to upload new recipe artifacts.
## Step 1: Go to Load Recipes
Click on _Deploy_ in the left-hand menu.
@@ -19,4 +21,3 @@ The artifact information will appear in the table if Moderne.io successfully loc
## Step 3: View recipes in the catalog
Your custom recipes will appear in the Catalog and be discoverable through search once successfully deployed.

597
references/api-schema.md
View File

@@ -1,597 +0,0 @@
# GraphQL API documentation
## Query
| 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
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **created** | [DateTime](api-schema.md#datetime)! | | |
| **description** | [String](api-schema.md#string) | | |
| **id** | [ID](api-schema.md#id)! | | |
### BranchResponse
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **branch** | [String](api-schema.md#string)! | | |
| **changeset** | [String](api-schema.md#string)! | Git SHA | |
### Event
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **edges** | \[[EventEdge](api-schema.md#eventedge)!\]! | | |
| **pageInfo** | [Page](api-schema.md#page)! | | |
### EventEdge
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **cursor** | [String](api-schema.md#string)! | | |
| **node** | [Event](api-schema.md#event)! | | |
### GithubAppInstallation
| 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
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **id** | [ID](api-schema.md#id)! | | |
| **name** | [String](api-schema.md#string)! | | |
### GithubRepository
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **accessToken** | [String](api-schema.md#string)! | | |
| **refreshToken** | [String](api-schema.md#string)! | | |
### Option
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **id** | [ID](api-schema.md#id)! | | |
| **name** | [String](api-schema.md#string)! | | |
### Page
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **endCursor** | [String](api-schema.md#string)! | | |
| **hasNextPage** | [Boolean](api-schema.md#boolean)! | | |
### PageInfo
Pagination Type - Generic
| 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
| 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
| 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
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **id** | [ID](api-schema.md#id)! | | |
| **name** | [String](api-schema.md#string)! | | |
### RecipeRun
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **edges** | \[[RecipeRunEdge](api-schema.md#reciperunedge)\] | | |
| **pageInfo** | [PageInfo](api-schema.md#pageinfo) | | |
### RecipeRunEdge
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **cursor** | [String](api-schema.md#string) | | |
| **node** | [RecipeRun](api-schema.md#reciperun) | | |
### RecipeRunResultsByRepository
| 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
| 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
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **id** | [ID](api-schema.md#id)! | | |
| **link** | [String](api-schema.md#string)! | | |
### RepositoryJavaVersion
| 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
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **edges** | \[[ResultEdge](api-schema.md#resultedge)\] | | |
| **pageInfo** | [PageInfo](api-schema.md#pageinfo) | | |
### ResultEdge
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **cursor** | [String](api-schema.md#string)! | | |
| **node** | [Result](api-schema.md#result)! | | |
### SourceFile
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **source** | [Base64](api-schema.md#base64)! | | |
| **sourcePath** | [Path](api-schema.md#path)! | | |
### SourceFileTypeCount
| 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
| Field | Argument | Type | Description |
| :--- | :--- | :--- | :--- |
| **connectedSince** | [DateTime](api-schema.md#datetime)! | | |
| **name** | [String](api-schema.md#string)! | | |
| **repositories** | \[[String](api-schema.md#string)!\]! | | |
## Inputs
### AdHocRecipeInput
| 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
| 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
| 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
| Field | Type | Description |
| :--- | :--- | :--- |
| **name** | [String](api-schema.md#string)! | Example: \`methodPattern\` |
| **value** | [Object](api-schema.md#object)! | Example: \`java.util.List add\(..\)\` |
### PartialRepositoryInput
| Field | Type | Description |
| :--- | :--- | :--- |
| **commit** | [CommitInput](api-schema.md#commitinput)! | |
| **id** | [String](api-schema.md#string)! | |
| **sourceFiles** | \[[SourceFileInput](api-schema.md#sourcefileinput)!\]! | |
### RecipeInput
| Field | Type | Description |
| :--- | :--- | :--- |
| **id** | [ID](api-schema.md#id)! | Example: \`org.openrewrite.java.search.FindMethods\` |
| **options** | \[[OptionInput](api-schema.md#optioninput)!\] | |
### RecipeRunInput
| 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
| Field | Type | Description |
| :--- | :--- | :--- |
| **source** | [Base64](api-schema.md#base64)! | |
| **sourcePath** | [Path](api-schema.md#path)! | |
## Enums
### ActionType
| Value | Description |
| :--- | :--- |
| **Create** | |
| **Delete** | |
| **Read** | |
| **Update** | |
### ErrorDetail
| 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
| 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
| Value | Description |
| :--- | :--- |
| **Organization** | |
| **User** | |
### RecipeRunState
| Value | Description |
| :--- | :--- |
| **CANCELED** | |
| **FINISHED** | |
| **RUNNING** | |
### RecipeRunSummaryState
| 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
| Value | Description |
| :--- | :--- |
| **ASC** | |
| **DESC** | |
## Scalars
### Base64
### Boolean
The `Boolean` scalar type represents `true` or `false`.
### DateTime
### Duration
String in ISO-8601. Example: `PT10S` -&gt; 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.
### Int
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -\(2^31\) and 2^31 - 1.
### Object
An object scalar
### Path
### String
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.

7
references/create-api-access-tokens.md
View File

@@ -6,9 +6,9 @@ You can create Personal Access Tokens \(PATs\) for interacting with the GraphQL
### Step 1: Go to the account menu
In the top right-hand corner of the app, click on your profile avatar and select _Access Tokens_
In the top right-hand corner of the app, click on your profile avatar and select _Account Settings_
![](../.gitbook/assets/global-account-menu.png)
![](../.gitbook/assets/account-settings-menu.png)
### Step 2: View list of any existing tokens
@@ -18,7 +18,7 @@ You From [https://app.moderne.io/settings/tokens](https://app.moderne.io/setting
## Creating an access token
### Step 1: Go to the _Access Token_ page from the account menu
### Step 1: Go to the _Access Token_ tab from the _Account Settings_ page
### Step 2: Name your token
@@ -39,4 +39,3 @@ Use the name of the token to distinguish it from other tokens.
From the _Access Token_ page, click _Delete_ next to the token you wish to revoke.
![](../.gitbook/assets/access-token-remove.png)

12
references/repository-selection.md
View File

@@ -1,12 +0,0 @@
# Repository selection
Before running recipes, selecting repositories can help focus your efforts. Here are some shortcuts available from the repository selection widget:
| Icon | Description |
| :--- | :--- |
| ![Add all repositories to selection ](../.gitbook/assets/select-all.png) | Add all repositories to selection |
| ![Remove all repositories from selection](../.gitbook/assets/remove-all.png) | Remove all repositories from selection |
| ![Add all search results to current repository selection](../.gitbook/assets/add-selected.png) | Add all search results to selection |
| ![Remove all search results from current repository selection](../.gitbook/assets/remove-selected.png) | Remove all search results from selection |
| ![Only select repositories from search results](../.gitbook/assets/select-only.png) | Select only search results |