Skip to content

Commit

Permalink
Add deprecation notice to v1 README
Browse files Browse the repository at this point in the history
  • Loading branch information
jessjenkins committed Aug 12, 2022
1 parent 9f22a04 commit 42db84e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -24,4 +26,4 @@ curl -X GET localhost:22000/datasets -H "Authorization: <invalid token>"
# With a valid auth token, responds with 200 OK request
curl -X GET localhost:22000/datasets -H "Authorization: <valid token>"
```
```

0 comments on commit 42db84e

Please sign in to comment.