Merge pull request #1196 from NHSDigital/develop

APIM-R 1.26 cut

Author: nhsd-david-wass

README.md

@@ -14,6 +14,12 @@ Consumers of the API will find developer documentation on the [NHS Digital Devel
 ## Contributing
 Contributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/e-referrals-service-api/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/e-referrals-service-api/blob/master/CODE_OF_CONDUCT.md).
 
+New branches and pull requests should always be created from the **develop** branch.
+
+All Pull Requests **must** be approved and merged only by one of the members of the [e-RS team](https://github.com/orgs/NHSDigital/teams/e-referrals).
+
+Merging to the **master** branch is part of our release process and should only ever be done by one of the members of the [e-RS team](https://github.com/orgs/NHSDigital/teams/e-referrals).
+
 ### Licensing
 This 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.
 
@@ -78,11 +84,11 @@ Each API and team is unique. We encourage you to use a `test/` folder in the roo
 
  * [**openapi-yaml-mode**](https://github.com/esc-emacs/openapi-yaml-mode) provides syntax highlighting, completion, and path help
 
-### Speccy
+### Redocly CLI
 
-> [Speccy](http://speccy.io/) *A handy toolkit for OpenAPI, with a linter to enforce quality rules, documentation rendering, and resolution.*
+> [Redocly CLI](https://redocly.com/redocly-cli) *Bring versatile OpenAPI validation, linting & bundling to your command line (and VS Code!) with this open-source Swiss knife.*
 
-Speccy does the lifting for the following npm scripts:
+Redocly CLI does the lifting for the following npm scripts:
 
  * `test` -- Lints the definition
  * `publish` -- Outputs the specification as a **single file** into the `build/` directory

package-lock.json

@@ -26,18 +26,18 @@ pyyaml = "^6.0"
 docopt = "^0.6.2"
 jsonpath-rw = "^1.4.0"
 semver = "^3.0.1"
-gitpython = "^3.1.36"
+gitpython = "^3.1.37"
 lxml = "^4.7.1"
 xmlformatter = "^0.2.4"
-pytest-check = "^2.2.1"
+pytest-check = "^2.2.2"
 requests = "^2.27.1"
 openapi-core = "0.17.1"
 
 
 [tool.poetry.dev-dependencies]
 flake8 = "^5.0.4"
 black = "^23.9"
-pip-licenses = "^4.3.2"
+pip-licenses = "^4.3.3"
 jinja2 = "^3.1.2"
 pytest = "^6.1.2"
 pytest-asyncio = "^0.20.3"

poetry.lock

@@ -17,6 +17,6 @@
     "lodash": "^4.17.20"
   },
   "devDependencies": {
-    "eslint": "^8.49.0"
+    "eslint": "^8.52.0"
   }
 }

pyproject.toml

@@ -1 +1,6 @@
-description: Locked - resource is locked
+description: |
+  The NHS e-Referral Service (e-RS) implements pessimistic locking functionality in order to prevent multiple users/systems attempting to update the same resource at the same time.
+
+  The e-RS API automatically acquires the lock on the behalf of the caller, within the scope of the request. When an endpoint call is received to update a resource, that resource will be locked for the duration of the request.
+
+  API callers should not attempt to make simultaneous requests to update the same resource. Any attempt to do so will result in a 423 (Locked) response. If a 423 response is received, then another system/user may be in the process of updating the resource. It will be necessary to fetch the resource again and re-try the request at a later time.