Settings menu and generated settings pages of the admin, with secrets and reset (A-34)

Offen
#3,422 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
csharp

Rechercherichtung

Read docs/planning/admin-technical-spec.md, sections 4.16, 5.1 and 10.7, plus the merged #3098 settings API work and the #3379 dependency. Start by tracing how the admin loads settings areas and how the content form handles If-Match conflicts. Done means implementing generated and plugin-provided settings pages, secret and reset behavior, and the listed component, API, and end-to-end coverage.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:admin type:feature

Problem

Rows 3.17, 8.7 and 7.13 ask for a settings page for each settings area, per site with the defaults of the instance, without a line of code from the plugin that registers the area. The Management API lists the areas (GET /settings, #3098) and gives each area's values with their JSON Schema, and the admin draws none of it. A half may also replace the page of its area with [SettingsPage]: the manifest has carried that since A-18, and nothing in the shell reads it.

Proposal

The settings menu and the pages /settings/{area} in the administration assembly (4.16):

  • The menu: the areas the caller may manage in the site and for the instance, each under its plugin or core, from GET /settings. An area that is read from the defaults only, as mcp is, offers the defaults alone.
  • The generated page: a form from the JSON Schema of the area's read, with the field editors of 4.6 for its properties, and a switch between the site's values and the defaults of the instance for a caller who may manage both.
  • The source the read gives is shown: the site's own, the defaults or the code default. It is the source of the area as a whole; a secret also says whether it is inherited (secretsInherited).
  • A secret (writeOnly in the schema) shows as set or not set (secretsSet) and never holds a value. It is written only when the user types one: the request never names a secret the user did not touch, since naming it would replace it.
  • A secret the key ring cannot read is in neither list and looks not set; the page says so beside a secret that is not set, until #3379 tells the two apart.
  • Save and reset send If-Match; a 412 shows the conflict as the content form does. Reset returns the site to the defaults, or the defaults to the code's, after a confirmation.
  • A page that a half declares with [SettingsPage(area)] replaces the generated one: gated with AdminPlugins.Shows and loaded with AdminPlugins.ComponentAsync, checked before it is rendered as a half's page is.

Acceptance

  • An administrator changes a setting of the site, sees it marked as the site's own, resets it and sees the default again
  • The defaults of the instance are changed by a caller who may, and the switch is absent for one who may not
  • A secret is set, shows as set, and a save of another field leaves it as it was; an inherited secret shows as inherited
  • A save over a change made elsewhere shows the conflict
  • The sample half's settings page shows in place of the generated one, and not in a site where its plugin is disabled
  • Component tests cover the menu, each kind of schema property, secrets and the conflict; the API tests check the records against the OpenAPI document; an end-to-end case changes and resets a setting

Design: docs/planning/admin-technical-spec.md, sections 4.16, 5.1 and 10.7 (A-34). Rows 3.17, 8.7, 7.13. Needs A-51; #3098 is merged. Size: M.

Vorherrschende Sprache
C#
Sterne
567
Forks
107
Ø Merge
1 Std. 19 Min.
Gemergte PRs (30 T.)
353

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus fluentcms/FluentCMS

Alle Issues in fluentcms/FluentCMS

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.