action graphhopper_get_geocode {
  label: "Geocoding Endpoint"
  description: "\n### Introduction\n\n![Geocoding Example](./img/geocoding-example.png)\n\n_Geocoding_ describes the process of transforming an textual address representation to a coordinate (`latitude,longitude`).\nFor example the conversion from `Berlin` to `52.5170365,13.3888599`.\n\n_Reverse geocoding_ converts a coordinate to a textual address representation or place name. Find out more about Geocoding itself on [Wikipedia](http://en.wikipedia.org/wiki/Geocoding).\n"
  provider: graphhopper
  method: GET
  path: "/geocode"
  encoding: json
  input: {
    type: "object"
    properties: {
      debug: {
        type: "boolean"
      }
      limit: {
        type: "integer"
        format: "int32"
      }
      locale: {
        type: "string"
      }
      point: {
        type: "string"
      }
      provider: {
        type: "string"
      }
      q: {
        type: "string"
      }
      reverse: {
        type: "boolean"
      }
    }
    additionalProperties: false
  }
  output: {
    properties: {
      hits: {
        type: "array"
        items: {
          type: "object"
          properties: {
            city: {
              type: "string"
              description: "The city of the address"
            }
            country: {
              type: "string"
              description: "The country of the address"
            }
            housenumber: {
              type: "string"
              description: "The housenumber of the address"
            }
            name: {
              type: "string"
              description: "The name of the entity. Can be a boundary, POI, address, etc"
            }
            osm_id: {
              type: "string"
              description: "The OSM ID of the entity"
            }
            osm_key: {
              type: "string"
              description: "The OSM key of the entity"
            }
            osm_type: {
              type: "string"
              description: "N = node, R = relation, W = way"
            }
            point: {
              type: "object"
              properties: {
                lat: {
                  type: "number"
                  format: "double"
                  description: "Latitude"
                }
                lng: {
                  type: "number"
                  format: "double"
                  description: "Longitude"
                }
              }
            }
            postcode: {
              type: "string"
              description: "The postcode of the address"
            }
            state: {
              type: "string"
              description: "The state of the address"
            }
            street: {
              type: "string"
              description: "The street of the address"
            }
          }
        }
      }
      took: {
        type: "number"
        format: "int64"
        description: "in ms"
      }
    }
  }
}