Schema-4.5 cleanup. (DOI model) #1111
Merged
Conversation
This file contains 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
svogt0511
force-pushed
the
schema-4.5-cleanup-r1
branch
from
c3eb8b4 to
467a13b
Compare
This was referenced Feb 2, 2024
svogt0511
requested review from
ashwinisukale,
codycooperross,
richardhallett,
jrhoads and
digitaldogsbody
digitaldogsbody
approved these changes
Feb 6, 2024
| @@ -5,7 +5,7 @@ | |||
|
|
|||
| class Doi < ApplicationRecord | |||
| PUBLISHER_JSON_SCHEMA = "#{Rails.root}/app/models/schemas/doi/publisher.json" | |||
| audited only: %i[doi url creators contributors titles publisher publisher_obj publication_year types descriptions container sizes formats version_info language dates identifiers related_identifiers related_items funding_references geo_locations rights_list subjects schema_version content_url landing_page aasm_state source reason] | |||
There was a problem hiding this comment.
Will removing this remove historical data about changes to the field from the activities table/index/endpoint?
There was a problem hiding this comment.
Great question. Deleting the field name from that line just tells the audit module (activities) to not record changes for that field. It won't erase historical data for publisher or leave those changes out of a call to /activities.
Changes are kept in the audited_changes column of the audits table. For reporting changes, activities just grabs audited_changes, but doesn't care what is in it. For recording changes, the publisher column will be gone, so of course we don't need it recorded.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
Related to: Issue #1016, PR#1112
Approach
STEP 1 - This PR which obsoletes the publisher column from the database by making it an active record virtual attribute. To preserve backward compatibility, 'publisher' is still accepted by the API as either a string or a hash, but is saved to the DB or read from the DB as publisher_obj. Also, the API publisher='true' flag still works as documented to return either a string or hash in the response.
STEP 2 - A second PR (PR#1112) which has the rake task to remove the publisher column from the DB, and contains the new schema.rb file.
Open Questions and Pre-Merge TODOs
Learning
Types of changes
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Reviewer, please remember our guidelines: