Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#818 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

  • #1023 di @dee077 — chiusa senza merge

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
django, python
Ambito
api, backend-api-design, documentation, security

Direzione di ricerca

Inizia esaminando docs/user/variables.rst e docs/user/rest-api.rst, quindi discuti il contratto dell'API con gli sviluppatori principali prima di modificare qualsiasi cosa. Il lavoro è completato quando i modelli supportati, il parametro opt-in, i campi della risposta, le autorizzazioni, l'ottimizzazione e il comportamento relativo ai dati sensibili sono stati concordati e documentati.

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

Descrizione

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.

Lingua principale
Python
Stelle
778
Fork
322
Merge medio
2g 19h
PR unite (30g)
7

Preparare l'ambiente

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 openwisp/openwisp-controller

Tutte le issue di openwisp/openwisp-controller

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.