Improving documentation with various other params that folks can use #23
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…initial Author's repository (@mwpenny)
… Could be made much better if re-written. That's for another day ;)
…ation for new params
Enhancing documentation for the node package
mwpenny
requested changes
Nov 6, 2019
|
|
||
| * **Optional parameters:** | ||
| There are many different search parameters. Some of these can be used in any search (i.e., `keywords`), but most are category-specific. For example, set `params["attributeMap[petsallowed_s]"] = "[1]"` to exclude pet-unfriendly landlords when searching for apartments. | ||
|
|
||
| Parameters can be found by using your browser's developer tools and performing a custom search on the Kijiji website. After submitting your search on Kijiji or updating the filter being applied, use your browser's network monitoring tool to examine the request for `https://www.kijiji.ca/b-search.html`. Any parameter used in the query string for this request is able to be specified in `params`. A few examples include: | ||
| Parameters can be found by using your browser's developer tools on `https://www.kijiji.ca/b-search.html` and performing a custom search on the Kijiji website. After submitting your search on Kijiji or updating the filter being applied, use your browser's network monitoring tool to examine the request for `https://www.kijiji.ca/b-search.html`. You could also find some hidden info in the rendered HTML under the `<form>` tag with the search string `formSubmit`. Any parameter used in the query string for this request is able to be specified in `params`. A few examples include: |
There was a problem hiding this comment.
The additional mention of https://www.kijiji.ca/b-search.html seems redundant.
Great find on the hidden form. Slight rewording suggestion to be a bit more specific - how about:
You can also find possible search parameters as hidden `input` elements in the `searchForm` form in the rendered HTML
?
| locationId: 1700185, // Same as kijiji.locations.ONTARIO.OTTAWA_GATINEAU_AREA.OTTAWA | ||
| categoryId: 27, // Same as kijiji.categories.CARS_AND_VEHICLES | ||
| sortByName: "priceAsc" // Show the cheapest listings first | ||
| locationId: 1700185, // REQUIRED. Same as kijiji.locations.ONTARIO.OTTAWA_GATINEAU_AREA.OTTAWA |
There was a problem hiding this comment.
Minor: could you format the spacing so all of these comments line up?
Also could you add a comment to indicate that these are not necessarily the only parameters
| address: "M5R1M3", // OPTIONAL. Postal code (Use without whitespaces) | ||
| radius: 10, // OPTIONAL. Max distance from address to consider as filter while retrieving ads | ||
| adType: "OFFER", // OPTIONAL. Offer Type as provided on Kijiji.ca (Choices are: OFFER and WANTED). By default, it is any i.e. both OFFER and WANTED | ||
| hasImages: true, // OPTIONAL. Set it to 1 to avoid returning Ads without Images as shown on Kijiji.ca |
There was a problem hiding this comment.
For consistency, Images should not be capitalized
| adType: "OFFER", // OPTIONAL. Offer Type as provided on Kijiji.ca (Choices are: OFFER and WANTED). By default, it is any i.e. both OFFER and WANTED | ||
| hasImages: true, // OPTIONAL. Set it to 1 to avoid returning Ads without Images as shown on Kijiji.ca | ||
| "attributeMap[furnished_s]": "[1]", // OPTIONAL. Used when looking for apartments. By default, it is any i.e. No preference. | ||
| "attributeMap[petsallowed_s]": "[1]", // OPTIONAL. Used when looking for apartments. By default, it is any i.e. No preference. |
There was a problem hiding this comment.
attributeMap[furnished_s] and attributeMap[petsallowed_s] no longer work. Likely other attributeMap properties too. See #20 / #20 (comment). It seems Kijiji removed a bunch of filtering :(
Could you remove these from the examples? Thanks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes only in the README.md documentation to improve usage of the code.