Eligibility Signposting Specification

This repository contains the OpenAPI specification and related tooling for the Eligibility Signposting API.

Table of Contents

• Repository Template
  • Table of Contents
  • Information
    • Prerequisites
    • Configuration
  • Sandbox
  • Specification
  • Deployment
  • Contributing
  • Contacts
  • Licence

Information

This repository was cloned from the nhs-england-tools/repository-template

Prerequisites

The following software packages, or their equivalents, are expected to be installed and configured:

• Docker container runtime or a compatible tool, e.g. Podman,
• asdf version manager,
• GNU make 3.82 or later,
• npm - Java version 17 or higher
• gsed - for MacOS only

Note

The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain make tasks will fail. On macOS, you will need Homebrew installed, then to install make, like so:

brew install make

You will then see instructions to fix your $PATH variable to make the newly installed version available. If you are using dotfiles, this is all done for you.

• GNU sed and GNU grep are required for the scripted command-line output processing,
• GNU coreutils and GNU binutils may be required to build dependencies like Python, which may need to be compiled during installation,

Note

For macOS users, installation of the GNU toolchain has been scripted and automated as part of the dotfiles project. Please see this script for details.

• Python required to run Git hooks,
• jq a lightweight and flexible command-line JSON processor.

Configuration

Installation and configuration of the toolchain dependencies

make config

Sandbox

There is a minimalist sandbox environment in sandbox with an accompanying README with instructions on how to run it locally.

Specification

The OpenAPI specification is stored in specification. In that folder, there is an accompanying README with instructions on how to produce an environment-specific specification and publish it using proxygen CLI.

Deployment

The deployment workflows are defined in the .github/workflows/ folder. There is an accompanying README with details on how the deployment works and how to use it.

Contributing

Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like

• Environment setup for contribution, i.e. CONTRIBUTING.md
• Coding standards, branching, linting, practices for development and testing
• Release process, versioning, changelog
• Backlog, board, roadmap, ways of working
• High-level requirements, guiding principles, decision records, etc.

Contacts

Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.

Licence

The LICENCE.md file will need to be updated with the correct year and owner

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

Any HTML or Markdown documentation is © Crown Copyright and available under the terms of the Open Government Licence v3.0.