US-EPA-CAMD / easey-ui

Project Management repo for EPA Clean Air Markets Division (CAMD) Business Suite of applications
MIT License
0 stars 0 forks source link

Update Error Messages for pagination endpoints #4169

Open MaeganWood64 opened 2 years ago

MaeganWood64 commented 2 years ago

Definition of Ready

User Story

As a User I want informative error messages for the pagination endpoints So that I know the page limit of the query I am making and where I can access larger queries

Acceptance Criteria

Given a User is making a request on any of the paginated endpoints (see list of endpoints in Dev notes) When the user omits the page parameter Then the missing page parameter error message is displayed with the addition of the following error message "For larger requests use the Streaming Services or CAMD Services APIs (https://www.epa.gov/power-sector/cam-api-portal#/documentation)."

Given a User is making a request on any of the paginated endpoints (see list of endpoints in Dev notes) When the user omits the per page parameter Then the missing per page parameter error message is displayed with the addition of the following error message "For larger requests use the Streaming Services or CAMD Services APIs (https://www.epa.gov/power-sector/cam-api-portal#/documentation)."

Given a User is making a request on any of the paginated endpoints (see list of endpoints in Dev notes) When the user exceeds the per page parameter Then the per page parameter exceedance error message is displayed with the addition of the following error message "For larger requests use the Streaming Services or CAMD Services APIs (https://www.epa.gov/power-sector/cam-api-portal#/documentation)."

Given a User is making a request to the Allowance Transactions endpoint in the Account Mgmt API When the user exceeds the date range limit Then the date range limit exceedance error message is displayed with the addition of the following error message "For larger requests use the Streaming Services or CAMD Services APIs (https://www.epa.gov/power-sector/cam-api-portal#/documentation)."

Development Notes

Endpoints to be modified with error messages are Account Mgmt API:

Does this Story require 508 Testing?

Context

(User journeys, design mockups, architectural diagrams, business rules, data element definitions)

Testing

Test Case: Tester:

Definition of Done

tlageman-epa commented 8 months ago

Believe this ticket will cover some issues that we are seeing in the Audit meetings. Two call's that are reproducible in dev as of 3/6/2024 that are returning incorrect error messages. For correct, see requirements above. Would be good to connect with audit team to see if any others have popped up or this has already been addressed by some other work. Each call below is in dev environment: