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

API support for SPA Featured Items #10943

Open
g-saracca opened this issue Oct 21, 2024 · 0 comments
Open

API support for SPA Featured Items #10943

g-saracca opened this issue Oct 21, 2024 · 0 comments
Labels
Feature: API FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 50 Size: 50 A percentage of a sprint. 35 hours. SPA.Q4.5 Collections page with a more Website-like or CMS look and feel SPA These changes are required for the Dataverse SPA Type: Feature a feature request

Comments

@g-saracca
Copy link

Overview of the Feature Request
As a first iteration of this feature I think we should focus on creating custom featured items and then we could move on to creating featured collections, datasets and files.

We need two API endpoints:

  • To create/modify the featured items.

  • To get the featured items of a specific collection.

This could be the model of the objects returned by the endpoint 👇

type FeaturedItem = CustomFeaturedItem | DvObjectFeaturedItem

type CustomFeaturedItem = {
  type: 'custom'
  title: string
  content: string
  image?: {
    url: string
    altText: string
  }
}

type DvObjectFeaturedItem = {
  type: DvObjectType // 'collection' | 'dataset' | 'file'
  linkUrl: string
  title: string
  description?: string
}

What kind of user is the feature intended for?
API Users, SPA Users

What inspired the request?
Q4 Roadmap

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
Add the possibility to create featured items within a collection.

Any open or closed issues related to this feature request?
IQSS/dataverse-frontend#514

@g-saracca g-saracca added Type: Feature a feature request Feature: API SPA These changes are required for the Dataverse SPA GREI Re-arch Issues related to the GREI Dataverse rearchitecture Size: 50 A percentage of a sprint. 35 hours. Original size: 50 SPA.Q4.5 Collections page with a more Website-like or CMS look and feel labels Oct 21, 2024
@GPortas GPortas added the FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: API FY25 Sprint 10 FY25 Sprint 10 (2024-11-06 - 2024-11-20) GREI Re-arch Issues related to the GREI Dataverse rearchitecture Original size: 50 Size: 50 A percentage of a sprint. 35 hours. SPA.Q4.5 Collections page with a more Website-like or CMS look and feel SPA These changes are required for the Dataverse SPA Type: Feature a feature request
Projects
Status: This Sprint 🏃‍♀️ 🏃
Development

No branches or pull requests

2 participants