remove 'redundant' classes and replace with strings#119
Merged
jbrown-xentity merged 3 commits intotiger-teamfrom Apr 3, 2026
Merged
remove 'redundant' classes and replace with strings#119jbrown-xentity merged 3 commits intotiger-teamfrom
jbrown-xentity merged 3 commits intotiger-teamfrom
Conversation
Removed classes: LiabilityStatement, LicenseDocument, MediaType, ProvenanceStatement, and RightsStatement Changes: - Dataset.liabilityStatement: accept a string instead of LiabilityStatement; update description for greater detail/clarity - license: accept a string instead of LicenseDocument; update description to include link to resources.data.gov info - mediaType, format, packageFormat, compressFormat: accept a string instead of MediaType - mediaType: add IANA link to description - format: update description to clarify the distinction between it and mediaType - Dataset.provenance: accept a single string instead of a list of ProvenanceStatements; update desc for greater detail/clarity - rights, accessRights: accept a string instead of RightsStatement - rights: standardize usage; switch to a list in all relevant classes; update description to clarify usage - accessRights: sync description across relevant classes
Changes: - liabilityStatement: switch from an object (LiabilityStatement) to a string - accessRights: switch from an object (RightsStatement) to a string - provenance: switch from a list of objects (ProvenanceStatements) to a string - rights: switch from an object (RightsStatement) to a list of strings
jbrown-xentity
approved these changes
Apr 3, 2026
Collaborator
jbrown-xentity
left a comment
There was a problem hiding this comment.
The description changes are helpful, and the simplification of classes are great.
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
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.
Summary
Should resolve: #115
Removed classes:
LiabilityStatement,LicenseDocument,MediaType,ProvenanceStatement, andRightsStatementChanges:
Dataset.liabilityStatement- accept a string instead ofLiabilityStatement; update description for greater detail/claritylicense- accept a string instead ofLicenseDocument; update description to include link to resources.data.gov infomediaType,format,packageFormat,compressFormat- accept a string instead ofMediaTypemediaType- add IANA link to descriptionformat- update description to clarify the distinction between it andmediaTypeDataset.provenance- accept a single string instead of a list ofProvenanceStatements; update description for greater detail/clarityrights,accessRights- accept a string instead ofRightsStatementrights- standardize usage; switch to a list in all relevant classes; update description to clarify usageaccessRights- sync description across relevant classesNote:
Discussion Topics
Should we accept a single entry or a list for
Dataset.liabilityStatement,Dataset.provenance, and thelicenseproperties? Although a string can be of variable length and include multiple sentences, I can imagine a metadata provider possibly wanting to include multiple links, which I guess they could provide in a comma-separated list that is still only one string.I'm uncertain on this one. Will probably stick with a single entry unless someone provides a compelling example/argument for a list.
Should we allow any string or enforce the IANA types like in DCAT-US 1.1? There could be further discussion over the implicated properties but at a minimum it would affect
Distribution.mediaTypeandDocument.mediaType.I'm leaning towards enforcing the IANA types, but think we should discuss further