Julian Simioni 4037c49c4b Store sanitised types from layers parameter This moves the list of types created by sanitising the layer API parameter from clean.layers to clean.types.from_layers. In subsequent commits, types created from address parsing, and the yet-to-be-implemented source parameter will also live in the clean.types object. This will allow moving logic to set cmd.type out of controllers, and into separate logic that can be a littler smarter. Also, it will no longer require the clean.default_layers_set flag to be passed all around like a nasty global variable.		9 years ago
controller	Store sanitised types from layers parameter	9 years ago
docs	Documentation and some ciao tests	10 years ago
helper	Whitespace	9 years ago
middleware	Change type back to layer... oooops	9 years ago
query	Merge pull request #171 from pelias/phrase_slop	9 years ago
routes	Fix missing legacyUrl behavior	9 years ago
sanitiser	Store sanitised types from layers parameter	9 years ago
service	remove all things that involved suggester including query mixer	10 years ago
src	Replace src/logger with pelias-logger.	10 years ago
test	Store sanitised types from layers parameter	9 years ago
.gitignore	remove code-climate hooks	10 years ago
.jshintignore	remove code-climate hooks	10 years ago
.jshintrc	adding jshintignore and jshintrc, pre commit hook js lint	10 years ago
.travis.yml	change dependency to git url until PR merged upstream, test travis against 0.10,0.12	10 years ago
DOCS.md	Add places endpoint to API docs	9 years ago
EXAMPLES.md	add examples	10 years ago
README.md	Document the pelias-config accessLog option.	10 years ago
app.js	Fix missing legacyUrl behavior	9 years ago
index.js	run webserver on all available cores, resolves #6	10 years ago
package.json	Merge branch 'master' of github.com:pelias/api into responses	9 years ago

README.md

API

![Gitter](https://badges.gitter.im/Join Chat.svg)

Documentation

See our API Documentation.

Install Dependencies

The API uses elasticsearch scripts for additional scoring/sorting logic. You must install them, as documented here. Failure to do so will result in the following error:

ElasticsearchIllegalArgumentException[Unable to find on disk script admin_boost]

Once you are done with installing the scripts, Run the following

npm install

scripts

The API ships with several convenience commands (runnable via npm):

npm start: start the server
npm test: run unit tests
npm run ciao: run functional tests (this requires that the server be running)
npm run docs: generate API documentation
npm run coverage: generate code coverage reports

pelias-config

The API recognizes the following properties under the top-level api key in your pelias.json config file:

accessLog: (optional) The name of the format to use for access logs; may be any one of the predefined values in the morgan package. Defaults to "common"; if set to false, or an otherwise falsy value, disables access-logging entirely.

Contributing

Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script fixtures in the test directory.