Skip to content

Edpub 1157 user filters#337

Open
ckd002 wants to merge 4 commits intodevelopfrom
EDPUB-1157-User-filters
Open

Edpub 1157 user filters#337
ckd002 wants to merge 4 commits intodevelopfrom
EDPUB-1157-User-filters

Conversation

@ckd002
Copy link
Contributor

@ckd002 ckd002 commented Feb 13, 2026

Description

During the endpoint review work earlier in the year the /api/data/users endpoint had the following notes identified:

- the user.findAll query takes an optional list of fields to return. This means that while the default is a small subset of fields there are other potential options so I've updated the specification to match the edpuser table.
- Also not sure how we would pass the array of requested fields so haven't added that as an option
- furthermore while you can query on the role/group I don't believe you can currently return it because it would need to appear in the group by clause.

This ticket addresses the notes above in order for the endpoint to be used for user filtering by group/role

Linked JIRA Task or Github Issue

JIRA Task: EDPUB-1157

Types of changes

What types of changes does your code introduce to Earthdata Pub (EDPub)?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if adding or updating the existing documentation resources)
  • Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the Contributing Guide
  • I have updated the CHANGELOG
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Validation Steps

This will help us get a jump start on validating your PR by describing the steps to replicate
and validate the expected behavior. (For an example of good validation instructions, check out Bryan's Bouncy Ball PR.)

  1. Make sure all merge request checks have passed (CI/CD).
  2. Pull related branches locally.
  3. Authenticate to the swagger
  4. Test the /api/data/users endpoint to verify that you can now pass query fields and that it will only return the requested fields.

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

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

Successfully merging this pull request may close these issues.

1 participant