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.

Sign up for GitHub

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

Jump to bottom

4439 filter docs #11701

Merged
merged 0 commits into from
Feb 2, 2023
Merged

4439 filter docs #11701

merged 0 commits into from
Feb 2, 2023

Conversation

kpethtel
Copy link
Contributor

@kpethtel kpethtel commented Feb 1, 2023 •
edited
Loading

Summary

  • Adds schema documentation for the filter param that links out to more extensive documentation (PR forthcoming). It also makes a small change to the filter lib. I decided to return the entire error object to the controller instead of just the message. This will give the controller more options.

Related issue(s)

  • department-of-veterans-affairs/va-mobile-team#4439

Testing done

  • specs only

Screenshots

Note: Optional

What areas of the site does it impact?

None at this time because filtering is not yet in use.

Acceptance criteria

  • I fixed|updated|added unit tests and integration tests for each feature (if applicable).
  • No error nor warning in the console.
  • Events are being sent to the appropriate logging solution
  • Documentation has been updated (link to documentation)
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
  • Feature/bug has a monitor built into Datadog or Grafana (if applicable)
  • If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
  • I added a screenshot of the developed feature

Requested Feedback

@kpethtel kpethtel requested review from a team as code owners February 1, 2023 21:51
@github-actions github-actions bot added the mobile label Feb 1, 2023
@va-vfs-bot va-vfs-bot temporarily deployed to 4439-filter-docs/main/main February 1, 2023 21:53 Inactive
aherzberg
aherzberg approved these changes Feb 2, 2023
View reviewed changes
modules/mobile/docs/params/filter.yml
@@ -0,0 +1,7 @@
description: |
This endpoint accepts the `filter` param. This must be provided in the format `filter[model_attribute][operation]=value`. For example, if your model implements an attribute called "status" and you want to receive only records where the status equals "complete", you would add the param `filter[status][eq]=complete`. At this time the only operations supported are eq and not_eq. For more information, see https://department-of-veterans-affairs.github.io/va-mobile-app/docs/Engineering/BackEnd/Architecture/RecordFiltering.
Copy link
Contributor

Choose a reason for hiding this comment

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

That link is broken right now but I'm assuming that'll come in another PR soon. looks good!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, the link is created by this PR that I just opened: department-of-veterans-affairs/va-mobile-app#4680

@kpethtel kpethtel merged commit 12521bf into master Feb 2, 2023
@kpethtel kpethtel deleted the 4439-filter-docs branch February 2, 2023 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aherzberg aherzberg aherzberg approved these changes

Assignees
No one assigned
Labels
mobile
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kpethtel @aherzberg @va-vfs-bot