Introduce Path Persons API endpoint#6070
Merged
neilkakkar merged 3 commits intomasterfrom Sep 22, 2021
Merged
Conversation
pauldambra
pushed a commit
that referenced
this pull request
Sep 23, 2021
* introduce path persons API endpoint * docs in query class
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
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
This PR introduces the
/api/person/path/endpoint, which allows querying for users on Paths.The request expects the same filter as given to Paths, plus two new parameters:
path_start_keyandpath_end_key. These determine the start and end point of Paths you want. Both of these are optional.Not specifying them means "get me all users on this path query".
Only specifying
path_start_keymeans "get me all users whose paths start at this key"Only specifying
path_end_keymeans "get me all users whose paths end at this key"Specifying both means "get me all users whose path starts at
start_keyand ends atend_key."Checklist