Files
Django_TasksApp/docs/api/routing.md
T

81 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# HTTP routing and API inventory
`main/tasksnest/urls.py` mounts Django admin, OAuth authorization/metadata, `/api/v1/`, and the planner, food, recipes, groceries, Home Assistant, stress and dreams browser URLconfs. The browser routes are in each app’s `urls.py`; methods and CSRF/session handling are specified by their views. This table lists all direct `/api/v1/` registrations from `main/food/api_urls.py` as of 2026-11-04. A path may support more than one method; inspect the view’s method guard and endpoint tests for the exact contract.
| Path after `/api/v1/` | View |
| --- | --- |
| `auth/whoami/` | `api.whoami` |
| `stress/` | `stress_api.collection` |
| `stress/<uuid:identifier>/` | `stress_api.item` |
| `dreams/` | `dream_api.collection` |
| `dreams/<uuid:identifier>/` | `dream_api.item` |
| `schema/` | `api_schema.schema` |
| `food/today/` | `api.today` |
| `food/products/` | `api.products` |
| `food/products/lookup/` | `api.product_lookup` |
| `food/products/create/` | `api.product_create` |
| `food/products/import/` | `api.product_import` |
| `food/log/` | `api.log_create` |
| `food/log/<uuid:identifier>/` | `api.log_item` |
| `food/log/<uuid:identifier>/attachments/` | `api.attachment_create` |
| `food/attachments/<uuid:identifier>/file/` | `api.attachment_file` |
| `food/attachments/<uuid:identifier>/` | `api.attachment_delete` |
| `kitchen/items/` | `api.inventory_collection` |
| `housekeeping/search/` | `housekeeping.search` |
| `housekeeping/scan/` | `housekeeping.scan` |
| `housekeeping/preview/` | `housekeeping.preview` |
| `housekeeping/apply/` | `housekeeping.apply` |
| `housekeeping/history/` | `housekeeping.history` |
| `nutrition/preview/` | `nutrition_api.preview` |
| `nutrition/commit/` | `nutrition_api.commit` |
| `nutrition/ingredients/` | `nutrition_api.ingredients` |
| `nutrition/ingredients/<uuid:identifier>/` | `nutrition_api.ingredient_correct` |
| `nutrition/sources/` | `nutrition_api.sources` |
| `nutrition/sources/<uuid:identifier>/` | `nutrition_api.source_item` |
| `nutrition/suggestion-exclusions/` | `nutrition_api.suggestion_exclusion` |
| `nutrition/recipe-feedback/` | `nutrition_api.recipe_feedback` |
| `nutrition/recipe-reviews/` | `nutrition_api.recipe_reviews` |
| `nutrition/find-meals/` | `nutrition_api.find_meals` |
| `dietary-preferences/` | `dietary_api.collection` |
| `dietary-preferences/audit/` | `dietary_api.history` |
| `dietary-preferences/evaluate-recipe/` | `dietary_api.evaluate_recipe` |
| `dietary-preferences/<uuid:identifier>/` | `dietary_api.item` |
| `dietary-preferences/<uuid:identifier>/archive/` | `dietary_api.archive` |
| `dietary-preferences/<uuid:identifier>/exceptions/` | `dietary_api.exception_collection` |
| `dietary-preferences/<uuid:identifier>/exceptions/<uuid:exception_id>/` | `dietary_api.exception_item` |
| `kitchen/import-groceries/` | `api.inventory_import_groceries` |
| `kitchen/bulk-update/` | `api.inventory_bulk_update` |
| `kitchen/bulk-delete/` | `api.inventory_bulk_delete` |
| `kitchen/items/<uuid:identifier>/` | `api.inventory_item` |
| `kitchen/stock/` | `api.inventory_stock` |
| `kitchen/consumption/preview/` | `api.inventory_preview` |
| `kitchen/consumption/` | `api.inventory_consume` |
| `kitchen/consumption/<uuid:identifier>/undo/` | `api.inventory_undo` |
| `hydration/daily/` | `api.hydration_daily` |
| `hydration/manual/` | `api.hydration_log` |
| `hydration/manual/<uuid:identifier>/` | `api.hydration_manual_entry` |
| `hydration/settings/` | `api.hydration_settings` |
| `groceries/` | `grocery_api.collection` |
| `groceries/<uuid:identifier>/` | `grocery_api.item` |
| `groceries/recipe/<uuid:identifier>/` | `grocery_api.recipe_import` |
| `recipes/` | `recipe_api.recipe_search` |
| `recipes/cook-later/` | `recipe_api.recipe_cook_later_collection` |
| `recipes/cook-later/<uuid:identifier>/` | `recipe_api.recipe_cook_later_item` |
| `recipes/create/` | `recipe_api.recipe_create` |
| `recipes/compositions/preview/` | `recipe_api.recipe_composition_preview` |
| `recipes/compositions/` | `recipe_api.recipe_composition_create` |
| `recipes/<uuid:identifier>/` | `recipe_api.recipe_item` |
| `recipes/<uuid:identifier>/links/` | `recipe_api.recipe_links` |
| `recipes/<uuid:identifier>/links/<uuid:link_id>/` | `recipe_api.recipe_link_item` |
| `recipes/<uuid:identifier>/variations/` | `recipe_api.recipe_variation` |
| `recipes/<uuid:identifier>/ingredients/` | `recipe_api.recipe_ingredient_create` |
| `recipes/<uuid:identifier>/ingredients/<int:item_id>/` | `recipe_api.recipe_ingredient_item` |
| `recipes/<uuid:identifier>/subrecipes/` | `recipe_api.recipe_subrecipe_create` |
| `recipes/<uuid:identifier>/subrecipes/<int:item_id>/` | `recipe_api.recipe_subrecipe_delete` |
| `recipes/<uuid:identifier>/stock/preview/` | `recipe_api.recipe_stock_preview` |
| `recipes/<uuid:identifier>/stock/confirm/` | `recipe_api.recipe_stock_confirm` |
| `recipes/stock-use/<uuid:identifier>/undo/` | `recipe_api.recipe_stock_undo` |
| `recipes/<uuid:identifier>/log/` | `recipe_api.recipe_log` |
Total direct API paths: **72**. No API v2 route is registered. `/api/v1/schema/` is the server’s schema endpoint; it is the first place to check request and response definitions. See [authentication](authentication.md) and [MCP](../mcp/overview.md).