JKHeadley/rest-hapi

Add option to populate subdocs

Open

#104 opened on Apr 18, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,181 stars) (156 forks)batch import
enhancementhelp wanted

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Mongoose populateNode.jsREST API design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
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.