api/docs/doc/msuccess.md

valid doc query

Generated: Thu Oct 23 2014 11:58:14 GMT-0400 (EDT)

Request

{
  "protocol": "http:",
  "host": "localhost",
  "method": "GET",
  "port": 3100,
  "path": "/doc?id=geoname:4221195&id=geoname:4193595"
}

Response

Status: 200
{
  "x-powered-by": "mapzen",
  "charset": "utf8",
  "cache-control": "public,max-age=60",
  "server": "Pelias/0.0.0",
  "access-control-allow-origin": "*",
  "access-control-allow-methods": "GET",
  "access-control-allow-headers": "X-Requested-With,content-type",
  "access-control-allow-credentials": "true",
  "content-type": "application/json; charset=utf-8",
  "content-length": "555",
  "etag": "W/\"22b-6aa14642\"",
  "date": "Thu, 23 Oct 2014 15:58:14 GMT",
  "connection": "close"
}

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -82.9207,
          34.36094
        ]
      },
      "properties": {
        "name": "Sanders Grove Cemetery",
        "admin0": "United States",
        "admin1": "Georgia",
        "admin2": "Hart County",
        "text": "Sanders Grove Cemetery, Hart County, Georgia"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -83.94213,
          33.32262
        ]
      },
      "properties": {
        "name": "Etheredge Cemetery",
        "admin0": "United States",
        "admin1": "Georgia",
        "admin2": "Butts County",
        "text": "Etheredge Cemetery, Butts County, Georgia"
      }
    }
  ],
  "date": 1414079894512
}

Tests

✓ 200 ok

response.statusCode.should.equal 200

✓ valid response

now = new Date().getTime()
should.exist json
should.not.exist json.error
json.date.should.be.within now-5000, now+5000

✓ valid geojson

json.type.should.equal 'FeatureCollection'
json.features.should.be.instanceof Array