search

vincere-io / restful-api-support

5 stars 0 forks source link

API Documentation enhancement about cursorMarker #13

Open SeraphicRav opened 4 years ago

SeraphicRav commented 4 years ago

In https://wix.vincere.io/documentation.html#tag/search about

As of 12.11.0, start param is limited to 10000. If you need deep paging, Vincere search supports cursorMask param. cursorMask param, at begining query, you need to pass in wildcard (*). The returned result with cursorMask param would include cursorMask for next page. You need to loop your query with cursorMask until the new cursorMask duplicated with some previous one.

Example of cursorMask usage:

GET /api/v2/candidate/search/fl=id,first_name, first_name_kana, created_date,photo,current_location;sort=created_date asc?cursorMark=QW9KK3BwV0d0ZXNDUHdsc2IyTmhiR2h2YzNRdWRtbHVZMlZ5WldSbGRpNWpiMjBoWTJGdVpHbGtZWFJsWHpNMk5qTTU=

I believe that adding an example about the wildcard is needed. It took me many tries before understanding that I had to add cursorMark=* in my query params.

phamvannam commented 4 years ago

@SeraphicRav cursorMark=* is input in first time you query and the second or after we should using cursorMark=QW9KK3BwV0d0ZXNDUHdsc2IyTmhiR2h.....

SeraphicRav commented 4 years ago

Yes.

I believe that in the documentation, an example of the first query should be written too.