Skip to content

docs: reconcile MVP.md checklist with the implemented MVP #145

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.

Sign up for GitHub

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

Merged
dmccoystephenson merged 1 commit into from
Jun 13, 2026
Merged

docs: reconcile MVP.md checklist with the implemented MVP #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 33 additions & 31 deletions docs/MVP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The **Minimum Viable Product (MVP)** for Viron establishes the core spatial simu

This document aligns with the [`../openapi/viron-api.json`](../openapi/viron-api.json) specification and serves as the implementation guide.

> **Status:** The endpoints and DTOs below are implemented and tested; the checked boxes reflect the current implementation. The remaining gap is aligning entity creation to a request-body contract, tracked in [#135](https://github.com/Preponderous-Software/viron/issues/135).

---

## 🎯 Purpose
Expand All @@ -19,58 +21,58 @@ Deliver a working, tested API that supports:
## 📌 Core Features

### 1. **Environment Management**
- [ ] `GET /api/v1/environments` – Retrieve all environments.
- [ ] `GET /api/v1/environments/{id}` – Retrieve a specific environment by ID.
- [ ] `GET /api/v1/environments/name/{name}` – Retrieve a specific environment by name.
- [ ] `GET /api/v1/environments/entity/{entityId}` – Get the environment containing a specific entity.
- [ ] `POST /api/v1/environments` – Create an environment (JSON body: `name`, `numGrids`, `gridSize`).
- [ ] `PATCH /api/v1/environments/{id}/name` – Update environment name (JSON body: `name`).
- [ ] `DELETE /api/v1/environments/{id}` – Delete an environment and all related entities, locations, and grids.
- [x] `GET /api/v1/environments` – Retrieve all environments.
- [x] `GET /api/v1/environments/{id}` – Retrieve a specific environment by ID.
- [x] `GET /api/v1/environments/name/{name}` – Retrieve a specific environment by name.
- [x] `GET /api/v1/environments/entity/{entityId}` – Get the environment containing a specific entity.
- [x] `POST /api/v1/environments` – Create an environment (JSON body: `name`, `numGrids`, `gridSize`).
- [x] `PATCH /api/v1/environments/{id}/name` – Update environment name (JSON body: `name`).
- [x] `DELETE /api/v1/environments/{id}` – Delete an environment and all related entities, locations, and grids.

---

### 2. **Grid Management**
- [ ] `GET /api/v1/grids` – Retrieve all grids.
- [ ] `GET /api/v1/grids/{id}` – Retrieve a grid by ID.
- [ ] `GET /api/v1/grids/environment/{environmentId}` – Retrieve all grids in an environment.
- [ ] `GET /api/v1/grids/entity/{entityId}` – Retrieve the grid containing a specific entity.
- [x] `GET /api/v1/grids` – Retrieve all grids.
- [x] `GET /api/v1/grids/{id}` – Retrieve a grid by ID.
- [x] `GET /api/v1/grids/environment/{environmentId}` – Retrieve all grids in an environment.
- [x] `GET /api/v1/grids/entity/{entityId}` – Retrieve the grid containing a specific entity.

---

### 3. **Location Management**
- [ ] `GET /api/v1/locations` – Retrieve all locations.
- [ ] `GET /api/v1/locations/{id}` – Retrieve a location by ID.
- [ ] `GET /api/v1/locations/environment/{environmentId}` – Retrieve locations in an environment.
- [ ] `GET /api/v1/locations/grid/{gridId}` – Retrieve locations in a grid.
- [ ] `GET /api/v1/locations/entity/{entityId}` – Retrieve the location of a specific entity.
- [ ] `PUT /api/v1/locations/{locationId}/entity/{entityId}` – Add an entity to a location.
- [ ] `DELETE /api/v1/locations/{locationId}/entity/{entityId}` – Remove an entity from a specific location.
- [ ] `DELETE /api/v1/locations/entity/{entityId}` – Remove an entity from its current location.
- [x] `GET /api/v1/locations` – Retrieve all locations.
- [x] `GET /api/v1/locations/{id}` – Retrieve a location by ID.
- [x] `GET /api/v1/locations/environment/{environmentId}` – Retrieve locations in an environment.
- [x] `GET /api/v1/locations/grid/{gridId}` – Retrieve locations in a grid.
- [x] `GET /api/v1/locations/entity/{entityId}` – Retrieve the location of a specific entity.
- [x] `PUT /api/v1/locations/{locationId}/entity/{entityId}` – Add an entity to a location.
- [x] `DELETE /api/v1/locations/{locationId}/entity/{entityId}` – Remove an entity from a specific location.
- [x] `DELETE /api/v1/locations/entity/{entityId}` – Remove an entity from its current location.

---

### 4. **Entity Management**
- [ ] `GET /api/v1/entities` – Retrieve all entities.
- [ ] `GET /api/v1/entities/{id}` – Retrieve a specific entity by ID.
- [ ] `POST /api/v1/entities` – Create a new entity.
- [ ] `DELETE /api/v1/entities/{id}` – Delete an entity.
- [x] `GET /api/v1/entities` – Retrieve all entities.
- [x] `GET /api/v1/entities/{id}` – Retrieve a specific entity by ID.
- [ ] `POST /api/v1/entities` – Create a new entity. _(Currently implemented as `POST /api/v1/entities/{name}` using a path variable; alignment to the request-body form documented here is tracked in [#135](https://github.com/Preponderous-Software/viron/issues/135).)_
- [x] `DELETE /api/v1/entities/{id}` – Delete an entity.

---

### 5. **Debug Utilities**
- [ ] `POST /api/v1/debug/create-sample-data` – Create an environment with grids, locations, and sample entities for testing.
- [ ] `POST /api/v1/debug/create-world-and-place-entity/{environmentName}` – Create a world and place a random entity.
- [x] `POST /api/v1/debug/create-sample-data` – Create an environment with grids, locations, and sample entities for testing.
- [x] `POST /api/v1/debug/create-world-and-place-entity/{environmentName}` – Create a world and place a random entity.

---

## 🧩 DTO Requirements

- [ ] **EnvironmentDTO** – Public representation of an environment.
- [ ] **CreateEnvironmentRequest** – Request body for creating environments (name, number of grids, grid size).
- [ ] **UpdateEnvironmentNameRequest** – Request body for updating environment names.
- [ ] **GridDTO** – Public representation of a grid.
- [ ] **LocationDTO** – Public representation of a location.
- [ ] **EntityDTO** – Public representation of an entity.
- [x] **EnvironmentDTO** – Public representation of an environment.
- [x] **CreateEnvironmentRequest** – Request body for creating environments (name, number of grids, grid size).
- [x] **UpdateEnvironmentNameRequest** – Request body for updating environment names.
- [x] **GridDTO** – Public representation of a grid.
- [x] **LocationDTO** – Public representation of a location.
- [x] **EntityDTO** – Public representation of an entity.

---

Expand Down
Loading