Use Cases Wanted!
The Fedora community is encouraged to add use cases in the format detailed below by creating a new sub-page from this wiki page. In order to ensure that the community's needs are reflected in the software, this input is critical.
Also, please review the existing use cases here and comment on or "like" ones as you see fit.
Use case structure (inspired by Wikipedia):
| Title (Goal) | |
|---|---|
| Primary Actor | |
| Scope | |
| Level | |
| Author | |
| Story (A paragraph or two describing what happens) |
- AIC Use Case: Content and Structural Validation
- AIC Use Case: Content Modeling
- AIC Use Case: De-duplication
- AIC User Case: Extra-Repository Access Control
- Amherst: async digital preservation to external storage
- Amherst: binary derivative generation
- Amherst: embargo handling
- Amherst: ID service
- Amherst: JSON-LD compaction service
- Amherst: Render fedora metadata resources as MODS/XML
- Amherst: template rendering service
- ESIP Use Case: Best Practices compliant OpenSearch API
- Generic Use Case: Adding http 'headers to Fedora resources (e.g. Signposting)
- Generic Use Case: Associating Fedora Object URIs with Web Services
- Generic Use Case: Distributing API Extensions
- Generic Use Case: Extensions implemented as JAX-RS resources
- Generic Use Case: Hot updating the configuration of an API Extension
- JHU API-X Use Case: Deposit workflow state
- JHU API-X Use Case: High-resolution image rendering service
- JHU API-X Use Case: Package Deposit
- JHU API-X Use Case: Provenance stream
- JHU API-X Use Case: Recover from failed package deposit
- JHU API-X Use Case: Retrieve domain objects
- JHU API-X Use Case: re-write Content-Disposition HTTP headers for LDP-NR resources
- SI - One Representation Derived from a Graph of Objects
- SI - Return an emulation of the data and behavior of an object or graph of objects
- SI - Return a representation that is created using a model of the essential characteristics of one or a graph of objects
- SI - Return a representation that is stable regardless of changes in the underlying object or objects
- Use Case: Exposing versions via Memento protocol
- Use case: ore:aggregation locking
- Use Case: Return a graph that has several RDF resources
8 Comments
Stefano Cossu
Not to be overly zealous, but a few more words describing what is expected to be in those fields would help. The Wikipedia page referred is a bit nebulous in regard to different flavors and individual terms.
Elliot Metsger
I agree. I ended up leaving "Scope" and "Level" blank, because it seems like those are values that can be filled in (if we deem necessary) after we review the use cases all together.
Egbert Gramsbergen
I think this is also a relevant use case: Transformation of (meta)data for certain types of resources
Elliot Metsger
Yes, I had meant to review the list of existing use cases to determine their relevance to this effort. Thanks for the reminder!
Joshua Westgard
Apologies for missing the second planning call. I will do my best to get some additional use cases posted this week.
Joshua Westgard
I have to admit, in reviewing the proposal and use cases assembled so far, I was not very sure about the necessity or sufficiency of APIX for the purposes for which I imagined we might use it, so instead of creating new use cases, I have instead just "liked" those that seemed most in line with our plans for Fedora.
Aaron Birkland
So have recent use cases and associated use cases pushed you in the direction of "probably unnecessary and not suffient", or in the other direction
Joshua Westgard
Well, I guess what it really comes down to is I don't know where to draw the line between what features are best handled in a traditional admin application layer (e.g. Hydra), what's already possible to do with a core Fedora (our instance is still a work in progress), how much can already be accomplished with Apache Camel or with things like reverse proxies, and how much really requires API-X. I do know that I like the ideas laid out in the original proposal, and we have plans for Fedora that seem to overlap with many of the use cases (e.g. research data applications, batch loading and asset package creation/shipping, asynchronous storage). So mostly I'm felling "this sounds interesting but it's over my head".