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.

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

suggest api documentation: should indicate other collections, should indicate that only startswith works #168

Closed
OriHoch opened this issue May 15, 2017 · 4 comments
Assignees

Comments

@OriHoch
Copy link
Contributor

OriHoch commented May 15, 2017

reproduction steps

expected
  • should see documentation that it's possible to do: /v1/suggest/PhotoUnits/{input}
    • could add a the collection as another param, like this: /v1/suggest/{collection}/{input}
  • should see that only startswith suggestions work at the moment and phonetic / contains don't work - (AFAIK -- need to verify)
actual
  • only possibilities in documentation are to suggest over all collections or over familyNames / places
    • no indication that it's possible to suggest for other collections (without the general suggest)
  • no indication that only startswith works - user might try to use it
@Libisch
Copy link
Contributor

Libisch commented May 16, 2017

@OriHoch

  • The description specifically indicates the startswith issue:
    Get suggestion of (...) DB titles in which the first characters match the user’s input(...)
    Should it be emphasized?
  • As to phonetic/contains - me too, never saw results there.

@OriHoch
Copy link
Contributor Author

OriHoch commented May 16, 2017

yes, it should be emphasized, because currently the response contains also phonetic and contains - so it's confusing.. (need to verify first that indeed this is how it works - that really phonetic and contains will never have results)

@Libisch
Copy link
Contributor

Libisch commented May 17, 2017

@TheGrandVizier Done. PR #172 approved and merged, changes visible here.

@Libisch Libisch self-assigned this May 17, 2017
@OriHoch
Copy link
Contributor Author

OriHoch commented May 22, 2017

done, no need to test

@OriHoch OriHoch closed this as completed May 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants