Skip to content

standardize "identifier" usage across all relevant classes#95

Open
zopalmer14 wants to merge 2 commits intomainfrom
enhancement/identifier-standardization
Open

standardize "identifier" usage across all relevant classes#95
zopalmer14 wants to merge 2 commits intomainfrom
enhancement/identifier-standardization

Conversation

@zopalmer14
Copy link

Should resolve: #93

Relevant classes: Catalog, Data Service, Dataset, Distribution, Document, Location, Standard

Changes:

  • Identfier class
    • add flexibility to allow it to be either a simple string or the more complex original definition of Identifier
  • identifier
    • Ensure all occurrences accept a single entry and not a list
    • All occurrences should accept either null or an Identifier object (i.e., an inline description or a string IRI)
  • otherIdentifier
    • Add to all relevant classes that are currently missing it (i.e., all except Dataset)
    • All occurrences should accept either null or a list of Identifier objects

For Discussion

While this should resolve the inconsistency in identifier usage across all of the relevant classes, allowing for both complex and simple identifier usage, there is still the issue of identifier not being required/mandatory in any of the classes at present. At minimum, it should be required for Dataset for backwards compatibility purposes and to allow Data.gov to manage/track changes to agency catalogs; however, I thought it might be worth discussing if there are any other classes where it might make sense to require identifier, in which case we can tackle all of the changes in one issue/PR.

Relevant classes: Catalog, Data Service, Dataset, Distribution, Document, Location, Standard

Changes:
- Identfier class
  - add flexibility to allow it to be either a simple string or the more complex original definition of Identifier
- identifier
  - Ensure all occurrences accept a single entry and not a list
  - All occurrences should accept either null or an Identifier object (i.e., an inline description or a string IRI)
- otherIdentifier
  - Add to all relevant classes that are currently missing it (i.e., all except Dataset)
  - All occurrences should accept either null or a list of Identifier objects
@zopalmer14 zopalmer14 added enhancement New feature or request ready-for-review labels Mar 23, 2026
@zopalmer14 zopalmer14 linked an issue Mar 23, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ready-for-review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize "identifier" usage

1 participant