JKHeadley/rest-hapi

Add option to populate subdocs

Open

#104 geöffnet am 18. Apr. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.181 Stars) (156 Forks)batch import
enhancementhelp wanted

Beschreibung

Via this comment:

It would be great if there were some way to specify an embed of 'subdoc.pets' that made populateEmbeddedDocs call .populate({ path: 'subdoc.pets' }) instead of .populate({ path: 'subdoc', populate: { path: 'pets' } }).

Need to develop syntax to specify between the two, ex: subdoc.pets vs subdoc:pets

Contributor Guide

Tech Stack
javascriptnodejsmongodb
Domain
backendapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Mongoose populateNode.jsREST API design
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
35
Research-Richtung
First, review the linked comment in issue #102 and the existing `populateEmbeddedDocs` function in the rest hapi codebase (likely in a helper file). Understand how embedding is currently handled. Then, propose a syntax to differentiate between deep populate (e.g., `subdoc:pets`) and simple populate (e.g., `subdoc.pets`). Consider updating the documentation and adding tests for the new option.