USUsr0002 ‐ Filter Data by Schema ID - OpenScienceChain/OSC-IS_Doc GitHub Wiki

Note on April 16, 2024

This US won't be implemented since we don't expect users to be able to read Schema IDs. Instead, they should be able to read Schema Names. Then, we're implementing a different story with the usage of schema name instead.

Acceptance criteria

US Identifier USUsr0002
Name Filter Data by Schema ID
Description As an user (PI or User) of the BC network, I want to filter Data based on a schema ID, so that I can check which data has been submitted under that schema.
Acceptance Criteria
1. * The user gets authenticated to the network, under an specific Project Id.
2. * The user sends out an invocation through the Org's API to list all the (...? List Artifacts IDs, List a few fields per Artifacts?? What exactly do we want to list?), associated to a Specific Schema ID.
3. * The user has to provide the SchemaId.
4. * The SchemaID needs to be validated so it has the appropriate format (I'm making this up, but, do we need this requirement? Can't recall how a SchemaID looks like. If it's uuid-like format, do we want to check it is actually uuid?). If it hasn't the right format, inform the user of the error.
5. * If no Artifact ID is found, then return a Json message like this: {'msg': 'There are currently no Artifacts submitted using the $SCHEMAID provided'}
6. * If there are artifacts, return a message to the user like this: {'artifactId': $ActuallID, 'artifactId': $ActualID, ...}

Assessment (INVEST)

CRITERIA REVIEW
Independent Story is independent enough.
Negotiable The story is negotiable.
Valuable The story is valuable for the user because it helps them obtain critical information about Artifacts history.
Estimable Estimation of the story will need the rest of the team's assessment.
Small The story is small and can be handled on time.
Testable The acceptance criteria establish specific conditions that determine where tests may be appropriately applied.