{"id":23421174,"url":"https://github.com/nhsdigital/service-search-api","last_synced_at":"2026-04-13T12:02:24.441Z","repository":{"id":37083793,"uuid":"494375686","full_name":"NHSDigital/service-search-api","owner":"NHSDigital","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-12T11:34:13.000Z","size":2728,"stargazers_count":1,"open_issues_count":18,"forks_count":2,"subscribers_count":33,"default_branch":"master","last_synced_at":"2026-01-12T19:24:05.280Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-05-20T08:04:29.000Z","updated_at":"2026-01-12T11:34:04.000Z","dependencies_parsed_at":"2024-05-13T12:31:25.446Z","dependency_job_id":"0232f4d8-f532-4383-a339-1f805587e0e0","html_url":"https://github.com/NHSDigital/service-search-api","commit_stats":null,"previous_names":[],"tags_count":86,"template":false,"template_full_name":null,"purl":"pkg:github/NHSDigital/service-search-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fservice-search-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fservice-search-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fservice-search-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fservice-search-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/service-search-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fservice-search-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28568833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T12:50:50.164Z","status":"ssl_error","status_checked_at":"2026-01-19T12:50:42.704Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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:18.031Z","updated_at":"2026-01-19T13:00:53.351Z","avatar_url":"https://github.com/NHSDigital.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# service-search-api\n\n![Build](https://github.com/NHSDigital/service-search-api/workflows/Build/badge.svg?branch=master)\n\nThis is a specification for the _service-search-api_ 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-   `sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.\n-   `scripts/` Utilities helpful to developers of this specification.\n-   `proxies/` Live (connecting to another service) and sandbox (using the sandbox container) Apigee API Proxy definitions.\n\nConsumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer).\n\n## Contributing\n\nContributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/service-search-api/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/service-search-api/blob/master/CODE_OF_CONDUCT.md).\n\n### Licensing\n\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\n-   make\n-   nodejs + npm/yarn\n-   [poetry](https://github.com/python-poetry/poetry)\n-   Java 8+\n\nFor step by step instructions on making these installations, refer to scripts/install_prerequisites.txt. These installations should only have to be done once.\n\n### Install\n\n```\n$ make install\n```\n\n#### Updating hooks\n\nYou can install some pre-commit hooks to ensure you can't commit invalid spec changes by accident. These are also run\nin CI, but it's useful to run them locally too.\n\n```\n$ make install-hooks\n```\n\n### Environment Variables\n\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\n\nThere are `make` commands that alias some of this functionality:\n\n-   `lint` -- Lints the spec and code\n-   `publish` -- Outputs the specification as a **single file** into the `build/` directory\n-   `serve` -- Serves a preview of the specification in human-readable format\n\n### Testing\n\nCurrently this repository only has smoketests.\n\n```\nmake smoketest\n```\n\nThese require the [APIGEE get_token tool](https://docs.apigee.com/api-platform/system-administration/using-gettoken) and a correctly configured environment:\n\n```\nSSO_LOGIN_URL=https://login.apigee.com\nAPIGEE_ENVIRONMENT=\"internal-dev\"\nSERVICE_BASE_PATH=\"service-search-api\"\nAPIGEE_API_TOKEN=\"$(get_token)\"\nSOURCE_COMMIT_ID=\"7aad0db8d58e2f67eeaf7b2ebc930fceb18b991a\"\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### 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\u003e [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator-cli) *OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec*\nOpenAPI Generator does the lifting for the following npm scripts:\n\n * `lint` -- Lints the definition\n * `publish` -- Outputs the specification as a **single file** into the `dist/` directory\n\n\u003e\u003e [ReDocly](https://redocly.com/docs) does the lifting for the serve npm script. \n\n * `serve` -- Uses redocly command preview-docs to serve 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\n\nSwagger UI unfortunately doesn't correctly render `$ref`s in examples, so use `speccy serve` instead.\n\n#### Apigee Portal\n\nThe Apigee portal will not automatically pull examples from schemas, you must specify them manually.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fservice-search-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fservice-search-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fservice-search-api/lists"}