pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

add docs

pull/4/head
Peter Johnson 10 years ago
parent
05fba480e9
commit
4353d3d7ce
5 changed files with 36 additions and 51 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 19
      docs/404.md
  2. 9
      docs/cors.md
  3. 27
      docs/index.md
  4. 9
      docs/jsonp.md
  5. 23
      docs/suggest/success.md

19
docs/404.md
Unescape View File

@ -1,6 +1,6 @@
# invalid path # invalid path
*Generated: Fri Sep 12 2014 19:14:09 GMT+0100 (BST)* *Generated: Fri Sep 12 2014 19:16:14 GMT+0100 (BST)*
## Request ## Request
```javascript ```javascript
{ {
@ -8,10 +8,7 @@
"host": "localhost", "host": "localhost",
"method": "GET", "method": "GET",
"port": 3100, "port": 3100,
"path": "/notexist", "path": "/notexist"
"headers": {
"User-Agent": "Ciao/Client 1.0"
}
} }
``` ```
@ -29,7 +26,7 @@ Status: 404
"content-type": "application/json; charset=utf-8", "content-type": "application/json; charset=utf-8",
"content-length": "35", "content-length": "35",
"etag": "W/\"23-dfdfa185\"", "etag": "W/\"23-dfdfa185\"",
"date": "Fri, 12 Sep 2014 18:14:09 GMT", "date": "Fri, 12 Sep 2014 18:16:14 GMT",
"connection": "close" "connection": "close"
} }
``` ```
@ -41,11 +38,6 @@ Status: 404
## Tests ## Tests
### ✓ content-type header correctly set
```javascript
response.should.have.header 'Content-Type','application/json; charset=utf-8'
```
### ✓ should respond in json with server info ### ✓ should respond in json with server info
```javascript ```javascript
should.exist json should.exist json
@ -53,6 +45,11 @@ should.exist json.error
json.error.should.equal 'not found: invalid path' json.error.should.equal 'not found: invalid path'
``` ```
### ✓ content-type header correctly set
```javascript
response.should.have.header 'Content-Type','application/json; charset=utf-8'
```
### ✓ cache-control header correctly set ### ✓ cache-control header correctly set
```javascript ```javascript
response.should.have.header 'Cache-Control','public,max-age=300' response.should.have.header 'Cache-Control','public,max-age=300'

9
docs/cors.md
Unescape View File

@ -1,6 +1,6 @@
# cross-origin resource sharing # cross-origin resource sharing
*Generated: Fri Sep 12 2014 19:14:09 GMT+0100 (BST)* *Generated: Fri Sep 12 2014 19:16:14 GMT+0100 (BST)*
## Request ## Request
```javascript ```javascript
{ {
@ -8,10 +8,7 @@
"host": "localhost", "host": "localhost",
"method": "GET", "method": "GET",
"port": 3100, "port": 3100,
"path": "/", "path": "/"
"headers": {
"User-Agent": "Ciao/Client 1.0"
}
} }
``` ```
@ -29,7 +26,7 @@ Status: 200
"content-type": "application/json; charset=utf-8", "content-type": "application/json; charset=utf-8",
"content-length": "50", "content-length": "50",
"etag": "W/\"32-85536434\"", "etag": "W/\"32-85536434\"",
"date": "Fri, 12 Sep 2014 18:14:09 GMT", "date": "Fri, 12 Sep 2014 18:16:14 GMT",
"connection": "close" "connection": "close"
} }
``` ```

27
docs/index.md
Unescape View File

@ -1,6 +1,6 @@
# api root # api root
*Generated: Fri Sep 12 2014 19:14:09 GMT+0100 (BST)* *Generated: Fri Sep 12 2014 19:16:14 GMT+0100 (BST)*
## Request ## Request
```javascript ```javascript
{ {
@ -8,10 +8,7 @@
"host": "localhost", "host": "localhost",
"method": "GET", "method": "GET",
"port": 3100, "port": 3100,
"path": "/", "path": "/"
"headers": {
"User-Agent": "Ciao/Client 1.0"
}
} }
``` ```
@ -29,7 +26,7 @@ Status: 200
"content-type": "application/json; charset=utf-8", "content-type": "application/json; charset=utf-8",
"content-length": "50", "content-length": "50",
"etag": "W/\"32-85536434\"", "etag": "W/\"32-85536434\"",
"date": "Fri, 12 Sep 2014 18:14:09 GMT", "date": "Fri, 12 Sep 2014 18:16:14 GMT",
"connection": "close" "connection": "close"
} }
``` ```
@ -44,11 +41,6 @@ Status: 200
## Tests ## Tests
### ✓ endpoint available
```javascript
response.statusCode.should.equal 200
```
### ✓ vanity header correctly set ### ✓ vanity header correctly set
```javascript ```javascript
response.should.have.header 'X-Powered-By','pelias' response.should.have.header 'X-Powered-By','pelias'
@ -59,11 +51,9 @@ response.should.have.header 'X-Powered-By','pelias'
response.should.have.header 'Cache-Control','public,max-age=60' response.should.have.header 'Cache-Control','public,max-age=60'
``` ```
### ✓ should respond in json with server info ### ✓ endpoint available
```javascript ```javascript
should.exist json response.statusCode.should.equal 200
should.exist json.name
should.exist json.version
``` ```
### ✓ content-type header correctly set ### ✓ content-type header correctly set
@ -76,3 +66,10 @@ response.should.have.header 'Content-Type','application/json; charset=utf-8'
response.should.have.header 'Charset','utf8' response.should.have.header 'Charset','utf8'
``` ```
### ✓ should respond in json with server info
```javascript
should.exist json
should.exist json.name
should.exist json.version
```

9
docs/jsonp.md
Unescape View File

@ -1,6 +1,6 @@
# jsonp # jsonp
*Generated: Fri Sep 12 2014 19:14:09 GMT+0100 (BST)* *Generated: Fri Sep 12 2014 19:16:14 GMT+0100 (BST)*
## Request ## Request
```javascript ```javascript
{ {
@ -8,10 +8,7 @@
"host": "localhost", "host": "localhost",
"method": "GET", "method": "GET",
"port": 3100, "port": 3100,
"path": "/?callback=test", "path": "/?callback=test"
"headers": {
"User-Agent": "Ciao/Client 1.0"
}
} }
``` ```
@ -29,7 +26,7 @@ Status: 200
"content-type": "application/javascript; charset=utf-8", "content-type": "application/javascript; charset=utf-8",
"content-length": "57", "content-length": "57",
"etag": "W/\"39-b8a2aba1\"", "etag": "W/\"39-b8a2aba1\"",
"date": "Fri, 12 Sep 2014 18:14:09 GMT", "date": "Fri, 12 Sep 2014 18:16:14 GMT",
"connection": "close" "connection": "close"
} }
``` ```

23
docs/suggest/success.md
Unescape View File

@ -1,6 +1,6 @@
# valid suggest query # valid suggest query
*Generated: Fri Sep 12 2014 19:14:09 GMT+0100 (BST)* *Generated: Fri Sep 12 2014 19:16:14 GMT+0100 (BST)*
## Request ## Request
```javascript ```javascript
{ {
@ -8,10 +8,7 @@
"host": "localhost", "host": "localhost",
"method": "GET", "method": "GET",
"port": 3100, "port": 3100,
"path": "/suggest?input=a&lat=0&lon=0", "path": "/suggest?input=a&lat=0&lon=0"
"headers": {
"User-Agent": "Ciao/Client 1.0"
}
} }
``` ```
@ -28,14 +25,14 @@ Status: 200
"cache-control": "public,max-age=60", "cache-control": "public,max-age=60",
"content-type": "application/json; charset=utf-8", "content-type": "application/json; charset=utf-8",
"content-length": "1248", "content-length": "1248",
"etag": "W/\"jtfnMCXDw5frK6L5eD1thg==\"", "etag": "W/\"htT1UWW77Ibdm7ncnD9KgA==\"",
"date": "Fri, 12 Sep 2014 18:14:09 GMT", "date": "Fri, 12 Sep 2014 18:16:14 GMT",
"connection": "close" "connection": "close"
} }
``` ```
```javascript ```javascript
{ {
"date": 1410545649156, "date": 1410545774257,
"body": [ "body": [
{ {
"text": "ACRELÂNDIA, Brazil", "text": "ACRELÂNDIA, Brazil",
@ -123,11 +120,6 @@ Status: 200
## Tests ## Tests
### ✓ 200 ok
```javascript
response.statusCode.should.equal 200
```
### ✓ valid response ### ✓ valid response
```javascript ```javascript
now = new Date().getTime() now = new Date().getTime()
@ -139,3 +131,8 @@ should.exist json.body
json.body.should.be.instanceof Array json.body.should.be.instanceof Array
``` ```
### ✓ 200 ok
```javascript
response.statusCode.should.equal 200
```

Write Preview
Loading…
Cancel
Save