emergency-auth-code-api

command module

v0.0.0-...-80e094b Latest Latest Go to latest Published: Mar 4, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Temporary - Server side application for the emergency auth code solution.

In order to run this service locally, you will need:

Clone this repository: go get github.com/companieshouse/emergency-auth-code-api
Build the executable: make build

Variable	Default	Description
`BIND_ADDR`	`-`	The host:port to bind to
`MONGODB_URL`	`-`	The mongo DB connection string
`MONGO_AUTHCODE_DATABASE`	`-`	Authcode mongo database
`MONGO_AUTHCODE_COLLECTION`	`-`	Authcode mongo collection
`MONGO_AUTHCODE_REQUEST_DATABASE`	`-`	Authcode Request mongo database
`MONGO_AUTHCODE_REQUEST_COLLECTION`	`-`	Authcode Request mongo collection
`ORACLE_QUERY_API_URL`	`-`	URL of the Oracle Query API
`QUEUE_API_LOCAL_URL`	`-`	URL of the Queue API

Method	Path	Description
GET	`/emergency-auth-code-service/healthcheck`	Standard healthcheck endpoint
GET	`emergency-auth-code-service/company/{company_number}/officers`	Get list of eligible officers
GET	`emergency-auth-code-service/company/{company_number}/officers/{officer_id}`	Get officer details
POST	`emergency-auth-code-service/auth-code-requests`	Create auth code request
GET	`emergency-auth-code-service/auth-code-requests/{auth_code_request_id}`	Get auth code request
PUT	`emergency-auth-code-service/auth-code-requests/{auth_code_request_id}`	Update auth code request

There is no documentation for this package.

Path	Synopsis
authcodeapi Package authcodeapi connects and sends requests to the authcode api flow	Package authcodeapi connects and sends requests to the authcode api flow
config Package config defines the environment variable and command-line flags	Package config defines the environment variable and command-line flags
dao Package dao provides access to the database.	Package dao provides access to the database.
handlers Package handlers contains the http handlers which receive requests to be processed by the API.	Package handlers contains the http handlers which receive requests to be processed by the API.
mocks
models Package models contains the required data structures.	Package models contains the required data structures.
oracle Package oracle connects to the Oracle Query API to retrieve officer details	Package oracle connects to the Oracle Query API to retrieve officer details
service Package service contains the controllers used by the the API endpoints.	Package service contains the controllers used by the the API endpoints.
transformers Package transformers contains data transformation functions	Package transformers contains data transformation functions
utils Package utils contains helper functions	Package utils contains helper functions