diff --git a/Home.md b/Home.md index 93a012c..d7e6190 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,42 @@ -# Deploy the Project on CamelX Platform +# Nominatim GeoCode Action -Deploy on CamelX Platform in three steps +Find locations on Earth by name and address. +This Kamelet expects in the body the `address` to find. +The return message will also contain the following headers with the geolocation info: + +- `CamelGeoCoderAddress` +- `CamelGeoCoderCity` +- `CamelGeoCoderCountryLong` +- `CamelGeoCoderCountryShort` +- `CamelGeoCoderLat` +- `CamelGeoCoderLng` +- `CamelGeoCoderLatlng` +- `CamelGeoCoderPostalCode` +- `CamelGeoCoderRegionCode` +- `CamelGeoCoderRegionName` +- `CamelGeoCoderStatus` -## Step 1: Create a release -From the project space, click on **"Create a release"** +The body will be returned in JSON format. -The new version is automatically available in the list +## Metadata -## Step 2: Deploy -Click on **"Deploy"** +| Property | Value | +|----------|-------| +| Type | action | +| Group | Geospatial | +| Namespace | Geo | +| Support Level | Stable | +| Provider | Apache Software Foundation | -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +## Properties -## Step 3: Expose -Enable **"Expose"** +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `serverUrl` | string | ✓ | | Url of the Nominatim server | -Choose an **API Gateway** (Internal, Public, etc.) +## Dependencies + +- `camel:core` +- `camel:jackson` +- `camel:geocoder` +- `camel:kamelet`