openDxlApi: '0.1'
info:
  title: 'MaxMind Geolocation DXL Service'
  version: 0.1.0
  description: 'The MaxMind DXL Python service exposes Host/IP Geolocation lookups in a MaxMind <a href=''http://dev.maxmind.com/geoip/geoip2/geolite2/''>GeoLite2</a> or <a href=''https://www.maxmind.com/en/geoip2-databases''>GeoIP2</a> database via the  <a href=''http://www.mcafee.com/us/solutions/data-exchange-layer.aspx''>Data Exchange Layer</a> (DXL) fabric.'
  contact:
    name: OpenDXL
    url: 'https://www.opendxl.com'
solutions:
  'MaxMind Geolocation DXL Service':
    info:
      title: 'MaxMind Geolocation DXL Service'
      version: 0.2.0
      description: 'The MaxMind DXL Service.'
    externalDocs:
      description: 'MaxMind API Reference'
      url: 'https://dev.maxmind.com/geoip/geoip2/web-services/#Product_Information'
    services:
      -
        $ref: '#/services/MaxMind DXL Service'
    events: []
services:
  'MaxMind Geolocation DXL Service':
    info:
      title: 'MaxMind Geolocation DXL Service'
      version: 0.2.0
      description: 'The MaxMind DXL Python service exposes Host/IP Geolocation lookups in a MaxMind <a href=''http://dev.maxmind.com/geoip/geoip2/geolite2/''>GeoLite2</a> or <a href=''https://www.maxmind.com/en/geoip2-databases''>GeoIP2</a> database via the  <a href=''http://www.mcafee.com/us/solutions/data-exchange-layer.aspx''>Data Exchange Layer</a> (DXL) fabric.'
    externalDocs:
      description: 'MaxMind DXL Python Service (GitHub)'
      url: 'https://github.com/opendxl/opendxl-maxmind-service-python'
    requests:
      -
        $ref: '#/requests/~1opendxl-maxmind~1service~1geolocation~1host_lookup'
requests:
  /opendxl-maxmind/service/geolocation/host_lookup:
    description: 'Invokes a MaxMind Host/IP geolocation lookup and returns the results.'
    payload:
      properties:
        host:
          description: 'Hostname or IP address for which to retrieve Geolocation information.'
          type: string
      required:
        - host
      example:
        host: 8.8.8.8
    response:
      description: 'A JSON structure representing the Geolocation information for the specified host/IP. See the <a href=''https://dev.maxmind.com/geoip/geoip2/web-services/#Response_Body''>MaxMind GeoIP2 Precision Web Services API</a> for more information.'
      payload:
        example:
          continent:
            code: NA
            geoname_id: 6255149
            names:
              de: Nordamerika
              en: 'North America'
              es: Norteamérica
              fr: 'Amérique du Nord'
              ja: 北アメリカ
              pt-BR: 'América do Norte'
              ru: 'Северная Америка'
              zh-CN: 北美洲
          country:
            geoname_id: 6252001
            iso_code: US
            names:
              de: USA
              en: 'United States'
              es: 'Estados Unidos'
              fr: États-Unis
              ja: アメリカ合衆国
              pt-BR: 'Estados Unidos'
              ru: США
              zh-CN: 美国
          location:
            accuracy_radius: 1000
            latitude: 37.751
            longitude: -97.822
          registered_country:
            geoname_id: 6252001
            iso_code: US
            names:
              de: USA
              en: 'United States'
              es: 'Estados Unidos'
              fr: États-Unis
              ja: アメリカ合衆国
              pt-BR: 'Estados Unidos'
              ru: США
              zh-CN: 美国
    errorResponses:
      '0':
        payload:
          $ref: '#/definitions/Error Response Object'
definitions:
  'Error Response Object':
    properties:
      errorMessage:
        description: 'Message string containing error information.'
        type: string
    example: 'Error invoking service with topic ''/opendxl-maxmind/service/geolocation/host_lookup'': argument 1 must be string, not int'