Feature: REST API for Grocery Module with JSON-LD #13

New issue

Closed

opened 2026-07-04 21:32:10 +00:00 by psycodepath · 0 comments

psycodepath commented

2026-07-04 21:32:10 +00:00

Owner

Motivation

Expose Grocery lists, items, and catalog products to external consumers.

Description

Create REST API endpoints under /api/v1/grocery/* for grocery lists, items, and pantry control with pagination and JSON-LD contexts.

User Story

As an API consumer, I want to manage grocery lists and catalog products programmatically so that I can build custom mobile/smart-home lists.

Gherkin Feature

Feature: Grocery REST API
  As an API consumer
  I want to read and write grocery resources
  So that my home automation system can query and update lists

Acceptance Criteria

GET /api/v1/grocery/lists (paginated collection of grocery lists).
GET /api/v1/grocery/lists/{id} (item view of a grocery list containing its items).
POST /api/v1/grocery/lists (create a new list).
POST /api/v1/grocery/lists/{id}/add (add an item).
POST /api/v1/grocery/lists/{listId}/toggle/{id} (toggle item bought status).
GET /api/v1/grocery/catalog (paginated list of catalog products).
Integration tests for all endpoints.

### Motivation Expose Grocery lists, items, and catalog products to external consumers. ### Description Create REST API endpoints under `/api/v1/grocery/*` for grocery lists, items, and pantry control with pagination and JSON-LD contexts. ### User Story As an API consumer, I want to manage grocery lists and catalog products programmatically so that I can build custom mobile/smart-home lists. ### Gherkin Feature ```gherkin Feature: Grocery REST API As an API consumer I want to read and write grocery resources So that my home automation system can query and update lists ``` ### Acceptance Criteria - [ ] `GET /api/v1/grocery/lists` (paginated collection of grocery lists). - [ ] `GET /api/v1/grocery/lists/{id}` (item view of a grocery list containing its items). - [ ] `POST /api/v1/grocery/lists` (create a new list). - [ ] `POST /api/v1/grocery/lists/{id}/add` (add an item). - [ ] `POST /api/v1/grocery/lists/{listId}/toggle/{id}` (toggle item bought status). - [ ] `GET /api/v1/grocery/catalog` (paginated list of catalog products). - [ ] Integration tests for all endpoints.

psycodepath added this to the v1.4.0-rest-api milestone

2026-07-04 21:32:10 +00:00

psycodepath self-assigned this

2026-07-04 21:32:10 +00:00

psycodepath referenced this issue from a pull request that will close it,

2026-07-04 21:47:05 +00:00

feat(grocery): implement JSON-LD REST API with hypermedia and pagination #17

psycodepath closed this issue

2026-07-05 19:28:35 +00:00

psycodepath referenced this issue from a commit

2026-07-05 19:28:35 +00:00

feat(grocery): implement JSON-LD REST API with hypermedia and pagination (#17)