diff --git a/Home.md b/Home.md index 93a012c..c30e15a 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,40 @@ -# Deploy the Project on CamelX Platform +# GraphQL -Deploy on CamelX Platform in three steps +Send GraphQL queries and mutations to external systems. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `graphql` | +| Support Level | Stable | +| Labels | api | +| Version | 4.10.2 | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel + camel-graphql + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `httpUri` | string | ✓ | | The GraphQL server URI. | +| `operationName` | string | | | The query or mutation name. | +| `proxyHost` | string | | | The proxy host in the format hostname:port. | +| `query` | string | | | The query text. | +| `queryFile` | string | | | The query file name located in the classpath. | +| `queryHeader` | string | | | The name of a header containing the GraphQL query. | +| `variables` | object | | | The JsonObject instance containing the operation variables. | +| `variablesHeader` | string | | | The name of a header containing a JsonObject instance containing the operation variables. | +| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | +| `accessToken` | string | | | The access token sent in the Authorization header. | +| `jwtAuthorizationType` | string | | `Bearer` | The JWT Authorization type. Default is Bearer. | +| `password` | string | | | The password for Basic authentication. | +| `username` | string | | | The username for Basic authentication. |