Skip to content
This repository has been archived by the owner on Jan 29, 2021. It is now read-only.

Add referrer_user_id filter to Posts endpoint documentation #1004

Merged
merged 2 commits into from Mar 24, 2020

Conversation

aaronschachter
Copy link
Contributor

@aaronschachter aaronschachter commented Mar 24, 2020

What's this PR do?

This pull request documents that the /v3/posts index supports filtering by referrer_user_id, per the addition to the $indexes property in #1003. Also populates the field in our database seeder to make it easier to test.

How should this be reviewed?

馃憖

Any background context you want to provide?

To find the total number of voter registration referrals for a user, our query will look like this:

GET /api/v3/posts?filter[referrer_user_id]=:userId&filter[type]=voter-reg

Relevant tickets

References Pivotal #170775705.

Checklist

  • This PR has been added to the relevant Pivotal card.
  • Documentation added for new features/changed endpoints.
  • Added appropriate feature/unit tests.

@aaronschachter aaronschachter requested a review from a team as a code owner March 24, 2020 19:17
@aaronschachter aaronschachter requested review from katiecrane and removed request for a team March 24, 2020 19:17
Copy link
Contributor

@katiecrane katiecrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!!

@aaronschachter aaronschachter merged commit 468a447 into master Mar 24, 2020
@aaronschachter aaronschachter deleted the filter-by-referrer branch March 24, 2020 20:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants