Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docker fix #16

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docker fix #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3665ff
Added information about paging
Jun 5, 2019
f95df3a
Set bundler to version compatible with ubuntu:trusty
Jun 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FROM ubuntu:trusty

RUN apt-get update
RUN apt-get install -yq ruby ruby-dev build-essential git
RUN gem install --no-ri --no-rdoc bundler
RUN gem install --no-ri --no-rdoc bundler -v=1.17.3
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be even more clever to update the whole Image instead...

ADD Gemfile /app/Gemfile
ADD Gemfile.lock /app/Gemfile.lock
RUN cd /app; bundle install
Expand Down
14 changes: 12 additions & 2 deletions source/includes/_products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,9 @@ curl https://api.zinc.io/v1/search?query=fish%20oil&page=1&retailer=amazon \
-u <client_token>:
```

Get search results from a retailer based on a query term. Results include product id, title, image url, number of reviews, star rating, and price.
Get search results from a retailer based on a query term. Results include product id, title, image url, number of reviews, star rating, and price as well as how many results are shown of all available.

The api is optimized for fast responses so results are paged. That means that if there are lots of results returned by your query, the response will be paged. You can retrieve more results by executing the query again with an increased page number. For example, if querying the first page lists `showing.start` as 1 and `showing.end` as 48 with a total amount of results as `showing.of` = 30000, you can expect 625 pages in total (30000/48). However, keep in mind that query results are not being cached on our server, so executing a query again with another page number could return different results and will also be billed as each query causes new workload. That means your application should allow the showing object for changes with each query you execute.

To retrieve search results, make a GET request to the following URL, replacing :query with a url-encoded query string and specifying the request attributes as query parameters in the URL.

Expand Down Expand Up @@ -320,7 +322,12 @@ retailer | String | The retailer you are searching on.
"fresh": false,
"price": 1642
}
]
],
"showing": {
"start": 1,
"end": 3,
"of": 121
}
}
```

Expand All @@ -338,6 +345,9 @@ results.num_reviews | Number | The number of reviews the product has
results.stars | String | The star rating of the item (e.g. '4.1 out of 5 stars')
results.fresh | Bool | Whether or not the product is an Amazon Fresh item
results.price | Number | The price of the item
showing.start | Number | The number of the first item returned by this request
showing.end | Number | The number of the last item returned by this request
showing.of | Number | Total amount of items

# Realtime Product Data

Expand Down