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

オープン
#319 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
静か
技術スタック
django, python
領域
api, backend

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
1
フォーク
0
平均マージ
23時間 9分
マージ済み PR(30日)
15

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pskillen/meshflow-api のほかの issue

pskillen/meshflow-api の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。