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 facility data labels to the new data dictionary #2088

Closed JanellC closed 2 years ago

JanellC commented 2 years ago

Definition of Ready

User Story

As a CAMPD user I want the facility data labels to be consistent with the EPA data dictionary so that I can understand the data

Acceptance Criteria

Given that a user has made a GET request to a facility API endpoint with the file type set to JSON When data is returned Then the JSON labels are consistent with Master data label dictionary (see context)

Given that a user has made a GET request to a facility API endpoint with the file type set to csv When data is returned Then the csv labels are consistent with the Master data label dictionary (see context)

Given that a user has selected preview data on the custom data download for facility/ unit attributes data When the functionality is displayed Then the data labels are consistent with the Master data label dictionary (see context)

Given that a user has navigated to the facility swagger page When the example schema is displayed for the facility/ unit attributes endpoint Then the values contain a description AND the description is consistent with the Master Data Dictionary (see context)

Development Notes

Facility endpoints include the following: /api/facility-mgmt/facilities /api/facility-mgmt/facilities/ attributes /api/facility-mgmt/facilities/ attributes / applicable /api/facility-mgmt/facilities {id}

Does this Story require 508 Testing?

Context

Final_CAMPD_Master Data Labels List_EPA CAMD_v1.0

1. Confirm or change name for parameters: Keep/Change
unitType Keep
unitFuelType Keep
controlTechnologies Keep
program change name to programCodeInfo
sourceCategories change name to sourceCategory
opHoursOnly change name to operatingHoursOnly
2. Need parameter descriptions for: New Description
unitFuelType Primary or Secondary fuel types combusted by the unit.
controlTechnologies Method or equipment used by the combusion unit to minimize Hg, NOx, PM, or SO2 emissions.
beginDate Begin date for a given period of a unit's emissions.
endDate End date for a given period of a unit's emissions.
opHoursOnly Indicator of whether or not a request should return only data for hours where a unit operated.
sourceCategories Unit classification in terms of its primary function.
transactionBeginDate Begin date for a given period of an account's allowance transaction history.
transactionEndDate End date for a given period of an account's allowance transaction history.
page Page number of data being requested
perPage Number of results per page

Testing

Test Case: TC395 Tester: @JanellC

Definition of Done

JanellC commented 2 years ago

TC395 passed @tlageman-epa