add audit events for GET endpoints #678
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
franmoore05
requested changes
Feb 10, 2026
api/versions.go
Outdated
| return nil, errs.ErrResourceState | ||
| } | ||
|
|
||
| if authorised && isStatic { |
Contributor
There was a problem hiding this comment.
There is no requirement to check for static types as part of this work.
franmoore05
requested changes
Feb 10, 2026
franmoore05
requested changes
Feb 10, 2026
| } | ||
|
|
||
| // ID and Email are the same as auth middleware can only provide userID | ||
| if err := api.auditService.RecordVersionAuditEvent(ctx, models.RequestedBy{ID: authEntityData.UserID, Email: authEntityData.UserID}, models.ActionRead, "/datasets/"+datasetID+"/editions/"+editionID, versionToAudit); err != nil { |
Contributor
There was a problem hiding this comment.
This should be moved to just before the response is returned to the user to ensure all the fields are completed (e.g. those completed via URL re-writing) and the edition model recorded if it is not a static dataset.
| } | ||
|
|
||
| // ID and Email are the same as auth middleware can only provide userID | ||
| if err := api.auditService.RecordVersionAuditEvent(ctx, models.RequestedBy{ID: authEntityData.UserID, Email: authEntityData.UserID}, models.ActionRead, "/datasets/"+datasetID+"/editions/"+edition+"/versions/"+version+"/metadata", versionDoc); err != nil { |
Contributor
There was a problem hiding this comment.
The metadata object should be recorded here instead of versionDoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Implement event tracking on GET endpoints
Jira - https://officefornationalstatistics.atlassian.net/browse/DIS-4411
How to review
To test locally, make a GET request to the endpoints specified in the acceptance criteria, and confirm that events are logged in the
dataset_eventsdatabase in mongodbChanges make sense, tests pass
Who can review
Anyone