Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return empty source object for all entity audit events #1074

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

ktuite
Copy link
Member

@ktuite ktuite commented Jan 25, 2024

This was meant to be part of backend PR #1072 but i forgot to push it!!

Frontend PR getodk/central-frontend#932 expects a source for every entity audit event, even API events, where the source is currently just {}.

What has been done to verify that this works as intended?

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Does this change require updates to the API documentation? If so, please update docs/api.md as part of this PR.

Before submitting this PR, please make sure you have:

  • run make test-full and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

@ktuite ktuite requested a review from matthew-white January 25, 2024 00:05
Copy link
Member

@matthew-white matthew-white left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a little funny to have a source object that's completely empty, but I guess it'd also be funny not to have a source property at all. I bet it simplifies Frontend to be able to assume that there is always a source property.

@ktuite
Copy link
Member Author

ktuite commented Jan 25, 2024

It seems a little funny to have a source object that's completely empty, but I guess it'd also be funny not to have a source property at all. I bet it simplifies Frontend to be able to assume that there is always a source property.

We will have to put something in there soon to distinguish between "API" bulk upload and API single operation when the source is not a submission.

@ktuite ktuite merged commit ce903f4 into master Jan 25, 2024
5 checks passed
@ktuite ktuite deleted the ktuite/extra_commit branch January 25, 2024 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants