Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[feature] Allow showing variables devices inherit from related objects in REST API

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

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

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

  • #1023 @dee077 による — マージされずにクローズ

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
django, python

調査の方向性

まず docs/user/variables.rst と docs/user/rest-api.rst を確認し、その後、何も変更する前にコア開発者と API コントラクトについて話し合ってください。サポート対象モデル、オプトインパラメータ、レスポンスフィールド、権限、最適化、機密データの動作について合意し、文書化されれば作業は完了です。

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

説明

blocked enhancement

⚠️ Not suited for beginner contributors.

A DESIGN DECISION AND MORE DISCUSSION ARE NEEDED ON THIS SUBJECT BEFORE MOVING FORWARD.
Please do not send a PR without having discussed your solution with the core devs first (for discussions, join our dev matrix chat).

The admin preloads and presents configuration variables so they can be understood and edited where appropriate. The REST API does not provide an equivalent, complete mechanism.

This work must cover every OpenWISP Controller model that defines or resolves configuration variables, rather than only the device API:

  • Device and Config: device-specific variables and the resolved effective context.
  • Template: default values and VPN-server variables.
  • DeviceGroup: group variables.
  • OrganizationConfigSettings: organization variables.
  • Vpn: VPN-server context.

The API must distinguish stored, user-editable variables from computed system-defined variables. Computed values should be read-only, and the design must account for sensitive values such as certificate material, private keys, and VPN secrets.

I think we can add either one or multiple properties showing these variables separately from the device configuration context. To avoid increasing normal list and detail response costs, this should be opt-in with a GET parameter. The design must define the response shape, permission and organization checks, query optimization, and which sensitive values are redacted or excluded.

The current user documentation in docs/user/variables.rst describes the variable sources and states that system-defined variables are displayed in the admin UI. Once an API contract is agreed, update this page and docs/user/rest-api.rst to document the supported models, opt-in parameter, response fields, and sensitive-data behavior.

主要言語
Python
スター
779
フォーク
328
平均マージ
2日 19時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

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

openwisp/openwisp-controller のほかの issue

openwisp/openwisp-controller の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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