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

add missing item_assets check + remove mlm:name unique requirement #8

Merged
merged 1 commit into from
Apr 29, 2024

Conversation

fmigneault
Copy link
Collaborator

Description

Added

  • Add the missing JSON schema item_assets definition under a Collection to ensure compatibility with
    the Item Assets extension, as mentioned this specification.

Removed

  • Field mlm:name requirement to be unique. There is no way to guarantee this from a single Item's definition
    and their JSON schema validation. For uniqueness requirement, users should instead rely on the id property
    of the Item, which is ensured to be unique under the corresponding Collection, since it would not be retrievable
    otherwise (i.e.: collections/{collectionID}/items/{itemID}).

Related Issue

n/a

Type of Change

  • 📚 Examples, docs, tutorials or dependencies update;
  • 🔧 Bug fix (non-breaking change which fixes an issue);
  • 🥂 Improvement (non-breaking change which improves an existing feature);
  • 🚀 New feature (non-breaking change which adds functionality);
  • 💥 Breaking change (fix or feature that would cause existing functionality to change);
  • 🔐 Security fix.

Checklist

  • I've read the CONTRIBUTING.md guide;
  • I've updated the code style using make codestyle;
  • I've written tests for all new methods and classes that I created;
  • I've written the docstring in Google format for all the methods and classes that I used.

@fmigneault fmigneault requested a review from rbavery April 27, 2024 01:24
@fmigneault fmigneault self-assigned this Apr 27, 2024
@fmigneault fmigneault merged commit 57fc826 into main Apr 29, 2024
9 checks passed
@fmigneault fmigneault deleted the mlm-name branch April 29, 2024 18:23
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