Retire API v1 ingest URLs (`/api/raw-packet/`, legacy node paths)

Aperta
  • Qualcosa non va?
#319 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
django, python
Ambito
api, backend

Direzione di ricerca

Start with Meshflow/urls.py and packets.urls to confirm that only the {node_id}/ingest/ and {node_id}/nodes/ routes are registered, then search the tree for any remaining v1 view code tied to /api/raw-packet/. Check openapi.yaml for the deprecated POST /raw-packet/ entry and the docs under docs/features/packet-ingestion/. Done means no v1 routes or view code remain, the docs describe v2 only, and any compatibility redirect decision is recorded. The bot-side change and the production proxy question need maintainer input before merging.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

Meshtastic packet ingest v1 used unscoped URLs (POST /api/raw-packet/, /api/nodes/) that predate the current packets app layout. v2 uses observer-scoped routes:

  • POST /api/packets/{node_id}/ingest/
  • POST /api/packets/{node_id}/nodes/

OpenAPI now documents v2 paths and marks POST /raw-packet/ as deprecated (SP-01 #308). v1 is not registered in the current Django urlconf (Meshflow/urls.py → packets.urls only exposes {node_id}/ingest/ and {node_id}/nodes/).

Goal

Formally retire v1 on the API side and coordinate with meshflow-bot dropping STORAGE_API_VERSION=1 (see linked bot issue).

Scope (API)

  • Confirm no production urlconf / reverse-proxy still depends on /api/raw-packet/ (or document explicit redirect shim if required during transition)
  • Remove or gate any dead v1 view code if it still exists in the tree
  • Update operator docs (docs/features/packet-ingestion/, deploy examples) to state v2-only
  • After bot default is v2 and operators migrated: remove deprecated POST /raw-packet/ from openapi.yaml (or keep stub only if a compat redirect remains)

Out of scope

  • URL prefix rename /api/packets/ → /api/meshtastic/ (meshcore rename SP-03+)
  • MeshCore ingest (/api/meshcore/packets/ingest/)

Related

Lingua principale
Python
Stelle
1
Fork
0
Merge medio
23h 9m
PR unite (30g)
15

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pskillen/meshflow-api

Tutte le issue di pskillen/meshflow-api

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.