https://github.com/dvsa/ftts-eligibility-secrets-manager

https://github.com/dvsa/ftts-eligibility-secrets-manager

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dvsa/ftts-eligibility-secrets-manager
• Owner: dvsa
• Created: 2022-04-12T11:29:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-01T16:19:10.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T04:43:08.739Z (9 months ago)
• Language: TypeScript
• Size: 149 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FTTS-ELIGIBILITY-SECRETS-MANAGER

...

## Local Config

```bash

npm run copy-config

```

Fill in the required configuration in local.settings.json

## Build

```bash

npm install

npm run build

```

## Test

```bash

npm run test

```

## Start

```bash

npm run start

```

## Healthcheck HTTP endpoint

eligibility-secrets-manager healthcheck function is a troubleshooting/support function to check connectivity with specific components used by application

GET /api//healthcheck - e.g. /api/v1/healthcheck

Responses:

- HTTP 200 (connections OK)

- HTTP 503 with response body containing specific errors details:

```json

{

  "status": "Service unavailable",

  "errors": [

    {

      "component": "",

      "message": "",

    }

  ]

}

```

- HTTP 500 with response body containing error message

Documentation - https://wiki.dvsacloud.uk/pages/viewpage.action?spaceKey=FB&title=Health+Checks