Skip to content

Commit

Permalink
updated README.md to reflect the swagger doc
Browse files Browse the repository at this point in the history
  • Loading branch information
WMTEH committed Jan 15, 2015
1 parent 2e6ab41 commit 648fe9f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -46,14 +46,15 @@ Execute the npm command to start the web application:

## Supported HTTP Operations
nutch-web-api supports the crawler job that performs all the nutch jobs in one call, and individual nutch job for clients who wants to invoke nutch job individually.
For details about each API operation, please refer to the swagger document hosted on the server and port of the web application: e.g. http://localhost:4000/api-docs

### Invoke Nutch Crawler Job
This API executes all the individual nutch jobs in the following order:
- inject, generate, fetch, parse, updatedb, solr index, solr delete duplicates
Any failure encountered during the processing of these jobs will result in the job failure.

- HTTP Method: **POST**
- Rest Endpoint: http://localhost:4000/nutch/crawl
- REST Endpoint: http://localhost:4000/nutch/crawl
- Sample Request Payload:

```json
Expand Down

0 comments on commit 648fe9f

Please sign in to comment.