Skip to content

Latest commit

 

History

History
115 lines (66 loc) · 2.05 KB

README.md

File metadata and controls

115 lines (66 loc) · 2.05 KB

FIGARO Validation Service

The DPS Validation Service provides a single operation that completely replacing the legacy DPS Validation services (Driver Fitness Case Management) previously hosted on webMethods.

Health check and self documenting Swagger-UI endpoints are also included.

These include:

  • getValidOpenDFCMCase

Getting Started

See Installing section for running the application locally. Refer to the https://github.com/bcgov/jag-dps/blob/master/README.md on how to build and deploy the project within a Docker container.

Configuration

No env variables

set the cloud active profile in order to activate environment variables overwriting: spring_profiles_active=cloud

Add the following flags

Environment Variable Description Notes
DFCMS_BASE_PATH the ords dfcms base path
DFCMS_USERNAME the ords dfcms username
DFCMS_PASSWORD the ords dfcms password

Health Checks

|TBD| | |

OpenAPI self documentation (Swagger-UI)

See Swagger-UI endpoint

Installing

Run

mvn clean install

Running the application

Run

mvn spring-boot:run

local operation endpoints

http://localhost:8081/figvalidationservice/locateMatchingApplicants
http://localhost:8081/figvalidationservice/validateApplicantService
http://localhost:8081/figvalidationservice/validateApplicantForSharing
http://localhost:8081/figvalidationservice/validateApplicantPartyId

others when complete here

http://localhost:8081/figvalidationservice/actuator/health 
http://localhost:8081/figvalidationservice/swagger-ui.html

Running the tests

Run

mvn test

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Built With

TBD

Contributing

TBD

Versioning

TBD

Authors

TBD

Acknowledgments

TBD