From 42db84ee788abab1c6def8cd6edeb70beeed0db9 Mon Sep 17 00:00:00 2001 From: Jessica Jenkins Date: Fri, 12 Aug 2022 09:47:12 +0100 Subject: [PATCH] Add deprecation notice to v1 README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a408ea..eda925a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # dp-authorisation +Note: This version of the library is deprecated. [Documentation for the newest version](https://github.com/ONSdigital/dp-authorisation/blob/main/README.md) can be found on the `main` branch. + Library providing functionality for applying an authorisation check to `http.HandlerFunc`. This will check the incoming request is authenticated (has a valid authorisation token) and then once identified will check if the user or service is authorised to access the endpoint/resources by verifying the user or service has the same permissions as those set against the handler. @@ -24,4 +26,4 @@ curl -X GET localhost:22000/datasets -H "Authorization: " # With a valid auth token, responds with 200 OK request curl -X GET localhost:22000/datasets -H "Authorization: " -``` \ No newline at end of file +```