Monitor Plan Data Management API

Description

Manages Monitor Plan and Location data for the EPA CAMD Business Systems. The Monitor Plan API endpoints return the monitor plans of a particular facility along with methods, supplemental methods, spans, formulas, defaults, systems and components of each monitor location associated with the plan. ​

Getting Started

Follow these instructions to get the project up and running correctly.

Installing

1. Open a terminal and navigate to the directory where you wish to store the repository.
2. Clone the repository using one of the following git cli commands or using your favorit Git management software
   Using SSH

   $ git clone git@github.com:US-EPA-CAMD/easey-monitor-plan-api.git
   

   Using HTTPS

   $ git clone https://github.com/US-EPA-CAMD/easey-monitor-plan-api.git
   

3. Navigate to the projects root directory

   $ cd easey-monitor-plan-api
   

4. Install package dependencies

   $ yarn install
   

Configuration

The Monitor Plan API uses a number of environment variables to properly configure the api. The following is the list of configureble values and their default setting.

Typescript Var Name	Environment Var Name	Default Value	Comment
apiHost	EASEY_API_GATEWAY_HOST	api.epa.gov/easey/dev	Configurable
apiKey	EASEY_MONITOR_PLAN_API_KEY	***	Dynamically set by CI/CD workflow
authApi.uri	EASEY_AUTH_API	https://api.epa.gov/easey/dev/auth-mgmt	Configurable
contentApi.uri	EASEY_CONTENT_API	https://api.epa.gov/easey/dev/content-mgmt	Configurable
currentUser	EASEY_MONITOR_PLAN_API_CURRENT_USER	{}	Configurable
description	EASEY_MONITOR_PLAN_API_DESCRIPTION	Monitor Plan management API endpoints for all monitor plan data & operations	Configurable
enableApiKey	EASEY_MONITOR_PLAN_API_ENABLE_API_KEY	false	Configurable
enableAuthToken	EASEY_MONITOR_PLAN_API_ENABLE_AUTH_TOKEN	false	Configurable
enableCors	EASEY_MONITOR_PLAN_API_ENABLE_CORS	true	Configurable
enableDebug	EASEY_MONITOR_PLAN_API_ENABLE_DEBUG	false	Configurable
enableGlobalValidationPipes	EASEY_MONITOR_PLAN_API_ENABLE_GLOBAL_VALIDATION_PIPE	true	Configurable
enableSecretToken	EASEY_MONITOR_PLAN_API_ENABLE_SECRET_TOKEN	false	Configurable
env	EASEY_MONITOR_PLAN_API_ENV	local-dev	Configurable
host	EASEY_MONITOR_PLAN_API_HOST	localhost	Configurable
logFile	EASEY_MONITOR_PLAN_API_LOG_FILE	""	Configurable
logFileLevel	EASEY_MONITOR_PLAN_API_LOG_FILE_LEVEL	""	Configurable
name	N/A	monitor-plan-api	Fixed value
path	EASEY_MONITOR_PLAN_API_PATH	monitor-plan-mgmt	Configurable
port	EASEY_MONITOR_PLAN_API_PORT	8010	Configurable
published	EASEY_MONITOR_PLAN_API_PUBLISHED	local	Dynamically set by CI/CD workflow
reqSizeLimit	EASEY_MONITOR_PLAN_API_REQ_SIZE_LIMIT	1mb	Configurable
secretToken	EASEY_MONITOR_PLAN_API_SECRET_TOKEN	***	Dynamically set by CI/CD workflow
title	EASEY_MONITOR_PLAN_API_TITLE	Monitor Plan Management	Configurable
version	EASEY_MONITOR_PLAN_API_VERSION	v0.0.0	Dynamically set by CI/CD workflow

Environment Variables File

Database credentials are injected into the cloud.gov environments as part of the CI/CD deployment process therefore they do not need to be configured. However, when running locally for local development the following environment variables are required to be configured using a local .env file in the root of the project. PLEASE DO NOT commit the .env file to source control.

• EASEY_MONITOR_PLAN_API_ENABLE_DEBUG=true|false
• EASEY_MONITOR_PLAN_API_ENABLE_API_KEY=true|false
  • IF ABOVE IS TRUE THEN SET
    • EASEY_MONITOR_PLAN_API_KEY={ask project dev/tech lead}
• EASEY_MONITOR_PLAN_API_ENABLE_AUTH_TOKEN=true|false
  • IF ABOVE IS TRUE THEN
    • USE AUTH API TO SIGNIN & GET AUTH TOKEN TO USE AS A BEARER TOKEN
  • IF ABOVE IS FALSE THEN SET
    • EASEY_MONITOR_PLAN_API_CURRENT_USER={see below}
    • FORMAT: { "facilities": [ { "facId": number, "orisCode": number, "permissions": string[] } ], "roles": <"ECMPS Admin" | "Initial Authorizer" | "Preparer" | "Submitter" | "Sponsor">[], "userId": string }
• EASEY_MONITOR_PLAN_API_ENABLE_SECRET_TOKEN=true|false
  • IF ABOVE IS TRUE THEN SET
    • EASEY_MONITOR_PLAN_API_SECRET_TOKEN={ask project dev/tech lead}

Please refer to our Getting Started instructions on how to configure the following environment variables & connect to the database.

• EASEY_DB_HOST
• EASEY_DB_PORT
• EASEY_DB_NAME
• EASEY_DB_USER
• EASEY_DB_PWD

Building, Testing, & Running the application

From within the projects root directory run the following commands using the yarn command line interface

Run in development mode

$ yarn start:dev

Install/update package dependencies & run in development mode

$ yarn up

Unit tests

$ yarn test

Build

$ yarn build

Run in production mode

$ yarn start

API Endpoints

Please refer to the Monitor Plan Management API Swagger Documentation for descriptions of the endpoints.
Dev Environment | Test Environment | Performance Environment | Beta Environment | Staging Environment

License & Contributing

This project is licensed under the MIT License. We encourage you to read this project’s License, Contributing Guidelines, and Code of Conduct.

Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.