{"id":23421178,"url":"https://github.com/nhsdigital/mesh-api-specification","last_synced_at":"2026-04-09T12:11:16.621Z","repository":{"id":40386848,"uuid":"288234752","full_name":"NHSDigital/mesh-api-specification","owner":"NHSDigital","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-21T11:34:52.000Z","size":1112,"stargazers_count":2,"open_issues_count":5,"forks_count":2,"subscribers_count":47,"default_branch":"master","last_synced_at":"2024-11-21T12:27:51.499Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-17T16:47:54.000Z","updated_at":"2024-11-15T10:41:37.000Z","dependencies_parsed_at":"2024-10-24T16:58:42.226Z","dependency_job_id":"d8bc35cd-94d5-4679-b2d4-0fc817fb6ead","html_url":"https://github.com/NHSDigital/mesh-api-specification","commit_stats":null,"previous_names":[],"tags_count":103,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fmesh-api-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fmesh-api-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fmesh-api-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fmesh-api-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/mesh-api-specification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230903878,"owners_count":18297817,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-23T02:14:19.074Z","updated_at":"2026-04-09T12:11:16.575Z","avatar_url":"https://github.com/NHSDigital.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mesh-api-api\n\n![Build](https://github.com/NHSDigital/mesh-api-api/workflows/Build/badge.svg?branch=master)\n\n* IMPORTANT: please read, https://nhsd-confluence.digital.nhs.uk/display/APM/Previewing+API+specification+on+Bloomreach+UAT+website\n\nThis is a RESTful HL7® FHIR® API specification for the *Message Exchange for Social Care and Health (MESH) API*.\n\n* `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.\n* `scripts/` Utilities helpful to developers of this specification.\n* `apiproxy/` The Apigee API Proxy\n\nConsumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api).  A description of the MESH service can be found at the [NHS Digital Services](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh)\n\n## Contributing\nContributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/mesh-api-api/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/mesh-api-api/blob/master/CODE_OF_CONDUCT.md).\n\n* IMPORTANT: please read, https://nhsd-confluence.digital.nhs.uk/display/APM/Previewing+API+specification+on+Bloomreach+UAT+website\n\n### Licensing\nThis code is dual licensed under the MIT license and the OGL (Open Government License). Any new work added to this repository must conform to the conditions of these licenses. In particular this means that this project may not depend on GPL-licensed or AGPL-licensed libraries, as these would violate the terms of those libraries' licenses.\n\nThe contents of this repository are protected by Crown Copyright (C).\n\n## Development\n\n### Requirements\n* make\n* nodejs + npm/yarn\n* [poetry](https://github.com/python-poetry/poetry)\n\n### Install\n```\n$ make install\n```\n\n#### Updating hooks\nSome pre-commit hooks are installed as part of the install command above to ensure you can't commit invalid spec changes by accident. These are also run\nin CI.\n\n```\n$ make install-hooks\n```\n\n### Environment Variables\nVarious scripts and commands rely on environment variables being set. These are documented with the commands.\n\n:bulb: Consider using [direnv](https://direnv.net/) to manage your environment variables during development and maintaining your own `.envrc` file - the values of these variables will be specific to you and/or sensitive.\n\n### Make commands\nThere are `make` commands that alias some of this functionality:\n * `lint` -- Lints the spec and code\n * `publish` -- Outputs the specification as a **single file** into the `dist/` directory\n * `serve` -- Serves a preview of the specification in human-readable format\n * `generate-examples` -- generate example objects from the specification\n\n\n### VS Code Plugins\n\n * [openapi-lint](https://marketplace.visualstudio.com/items?itemName=mermade.openapi-lint) resolves links and validates entire spec with the 'OpenAPI Resolve and Validate' command\n * [OpenAPI (Swagger) Editor](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) provides sidebar navigation\n\n\n### Emacs Plugins\n\n * [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help\n\n### Speccy\n\n\u003e [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*\n\nSpeccy does the lifting for the following npm scripts:\n\n * `test` -- Lints the definition\n * `publish` -- Outputs the specification as a **single file** into the `dist/` directory\n * `serve` -- Serves a preview of the specification in human-readable format\n\n(Workflow detailed in a [post](https://developerjack.com/blog/2018/maintaining-large-design-first-api-specs/) on the *developerjack* blog.)\n\n:bulb: The `publish` command is useful when uploading to Apigee which requires the spec as a single file.\n\n### Caveats\n\n#### Swagger UI\nSwagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `speccy serve` instead.\n\n#### Apigee Portal\nThe Apigee portal will not automatically pull examples from schemas, you must specify them manually.\n\n## Deployment\n\n#### Environment variables\n\nYou need a apgiee account to deploy to apigee\n* `APIGEE_USERNAME` - your apigee username\n* `APIGEE_PASSWORD` - your apigee password\n\nNavigate to develop/specs in the apigee ui and select the spec you want to update, the APIGEE_SPEC_ID is the last id in the url\n.../specs/folder/.../editor/{APIGEE_SPEC_ID}\n* `APIGEE_SPEC_ID`\n\nNavigate to publish/portals\nIn chrome open the developer tools to monitor network traffic\nFor the portal that your spec belongs to click on \"manage spec snapshot\"\nThen click \"update snapshot\" the APIGEE_PORTAL_API_ID will be the number in the network tab.\n* `APIGEE_PORTAL_API_ID`\n\nThis is the value in the top left corner of the apigee web-console\n* `APIGEE_ORGANIZATION`\n\nComma-separated list of environments to deploy to (e.g. `test,prod`)\n* `APIGEE_ENVIRONMENTS`\n\nName of the API Proxy for deployment\n* `APIGEE_APIPROXY`\n\nThe proxy's base path (must be unique)\n* `APIGEE_BASE_PATH`\n\nName of the environment you are running tests against\n* `ENVIRONMENT`\n\nThe base url of the proxy when deployed to apigee\n* `API_TEST_URL`\n\n### Github Deployment\n\nGithub uses Github actions to deploy the code to apigee. The Github action uses secrets to populate environment variables.\nYou need a Github secret for each environment variable. Each of the above environment variables need an equivalent secret in Github for\nthe deployment to work. These are pre-populated for you [here](https://github.com/NHSDigital/mesh-api-api/settings/secrets/new). \nIf you get a 404 for this page you will need to update your Github account permissions.\n\n### Local Deployment\n\n#### Specification\nUpdate the API Specification and derived documentation in the Portal.\n\nThis will only allow you to update an existing spec, so you have to create the spec first using the apigee web console.\n\n`make deploy-spec` with environment variables:\n\n* `APIGEE_USERNAME`\n* `APIGEE_PASSWORD`\n* `APIGEE_SPEC_ID`\n* `APIGEE_PORTAL_API_ID`\n\n#### API Proxy \u0026 Sandbox Service\nRedeploy the API Proxy and hosted Sandbox service.\n\nIf you use the same APIGEE_APIPROXY it will just create a new revision of the api proxy.\n\nIf you use the same APIGEE_BASE_PATH as an existing api proxy it will cause problems.\n\n`make deploy-proxy` with environment variables:\n\n* `APIGEE_USERNAME`\n* `APIGEE_PASSWORD`\n* `APIGEE_ORGANIZATION`\n* `APIGEE_ENVIRONMENTS`\n* `APIGEE_APIPROXY`\n* `APIGEE_BASE_PATH`\n\n:bulb: Specify your own API Proxy (with base path) for use during development.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fmesh-api-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fmesh-api-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fmesh-api-specification/lists"}