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

Add Transfer API Endpoint Search Example to docs #254

Open
sirosen opened this issue Dec 4, 2017 · 0 comments
Open

Add Transfer API Endpoint Search Example to docs #254

sirosen opened this issue Dec 4, 2017 · 0 comments
Labels
docs New or updated documentation good first issue A good issue for first-time contributors

Comments

@sirosen
Copy link
Member

sirosen commented Dec 4, 2017

Based off of #253, I think it would be nice to have another advanced TransferClient usage example focusing on endpoint_search()

I don't want to be re-documenting the API behaviors, but rather showing how you can use the iterable results to get more sophisticated behavior.
Something along these lines:

  • Create three endpoints with content in their Keywords, Organization, and Department fields
  • Perform searches which capture cross-sections of these endpoints
  • Show a search which captures two of them "accidentally" (e.g. Organization for EP1 and Keywords for EP2 both have the same content)
  • Show how to check fields for stricter matching client-side to fix the prior search (capture EPs with overlapping fields, then explicitly check that Organization=X)
@sirosen sirosen added the docs New or updated documentation label Dec 4, 2017
@sirosen sirosen added the good first issue A good issue for first-time contributors label Dec 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs New or updated documentation good first issue A good issue for first-time contributors
Projects
None yet
Development

No branches or pull requests

1 participant