Rhythm 2.0 Specifications

Appearance

CAP-MBR-STR-018Maintain configuration with consistent change safeguards

Markdown

CAP-MBR-STR-018

Maintain configuration with consistent change safeguards

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-MBR-STR-06
Exercised by
FAS-MBR-STR-04-03, FAS-MBR-STR-04-05, FAS-MBR-STR-06-01, FAS-MBR-STR-06-02, FAS-MBR-STR-06-03, FAS-MBR-STR-06-04, FAS-MBR-STR-06-05
Key concepts
CON-MBR-STR-006
Actors
ACT-MBR-001, ACT-MBR-002, ACT-MBR-003
Journeys
JNY-MBR-STR-004
Related
CAP-MBR-STR-009, CAP-MBR-STR-011, CAP-MBR-STR-012, CAP-MBR-STR-014, CAP-MBR-STR-017
Proved by
ATS-MBR-STR-018

Implementation

Executable suites
TST-MBR-STR-021, TST-MBR-STR-022, TST-MBR-STR-023, TST-MBR-STR-024, TST-MBR-STR-025, TST-MBR-STR-026, TST-MBR-STR-029, TST-MBR-STR-053, TST-MBR-STR-055, TST-MBR-STR-092, TST-MBR-STR-095

KindCapabilityProduct areaMembershipModuleOrganizational Structure, Membership Configuration and TermsRevision1

Read atservices-membership 5994c270react-console baf6dae3

Maintain configuration with consistent change safeguards ​

Purpose ​

Administrators change membership configuration without silently overwriting newer edits or removing referenced records.

How It Works ​

An administrator reads a configuration record before submitting a change. The request identifies that version. The service rejects an intervening edit rather than silently replacing it. Configuration changes are partial, retaining omitted keys. Submitted child lists use complete-list replacement. Validation evaluates the record and children within one transaction. A failing list therefore leaves the earlier aggregate intact. References can also prevent deletion, with staff directed toward retirement where available. Lists provide bounded continuation in identifier order. These safeguards differ from the structure’s full replacements and some optional version checks. The product should make those differences clear and decide whether stored locks become operational controls.

Relationships ​

  • Programs, types, packages, reasons and policy sets use these shared safeguards.
  • Access controls decide which administrator can invoke them.
  • Bulk configuration operations reuse the ordinary configuration processes.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Configuration mutations identify the version being changed.Record and owned-list changes succeed or fail together.
Surfaces
apijob

Controls

34 controls apply, from the corpus control catalogue.

TC-AVL-002 TC-AVL-003 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-DAT-001 TC-DAT-004 TC-DAT-007 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-PI-001 TC-PI-003 TC-PI-005 TC-SEC-001 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003

Permissions

KeyChecked atScope
membership.programs.readapitenant
membership.programs.manageapitenant
membership.configuration.readapitenant
membership.configuration.manageapitenant
membership.application.accessapitenant

Business Rules

11 rules, 9 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Programs, types, reasons and policy sets use supplied or name-derived readable identifiers of at most 63 characters; packages use the product identity instead.
proved by ATS-MBR-STR-018-01, TST-MBR-STR-021, TST-MBR-STR-022
validationapi, service, databaseobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:createConfiguration
02must prove
Proposed
A retained record’s identifier is immutable and duplicate creation fails without changing it.
proved by ATS-MBR-STR-018-02, TST-MBR-STR-022
validationservice, databaseobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:updateConfiguration
03must prove
Proposed
Changes and deletions require a positive version and reject stale versions without applying the mutation.
proved by ATS-MBR-STR-018-03, ATS-MBR-STR-018-13, TST-MBR-STR-023, TST-MBR-STR-024
validationapi, serviceobserved
services-membership:modules/configuration/services/persistence/configuration-store.ts:configurationStore
04must prove
Proposed
Configuration updates keep omitted keys, clear nullable keys when null is supplied, normalize empty strings, reject blank required text and unknown keys, and replace only submitted lists.
proved by ATS-MBR-STR-018-04, TST-MBR-STR-025
validationapi, serviceobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:updateConfiguration
05must prove
Proposed
Foreign-key dependencies prevent deletion, while removal of an unreferenced record includes its owned lists.
proved by ATS-MBR-STR-018-05, ATS-MBR-STR-018-14, TST-MBR-STR-026, TST-MBR-STR-055
lifecycledatabase, serviceobserved
services-membership:modules/configuration/services/persistence/configuration-store.ts:configurationStore
06must prove
Proposed
A configuration record and its submitted lists are written transactionally, leaving no partial create or update when validation fails.
proved by ATS-MBR-STR-018-06, ATS-MBR-STR-018-10, ATS-MBR-STR-018-11, ATS-MBR-STR-018-12, TST-MBR-STR-053, TST-MBR-STR-092
invariantserviceobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:createConfiguration
07must prove
Proposed
Known database checks and reference failures become field-naming refusals, with out-of-range values rejected by bounded input schemas or translated database errors.
proved by ATS-MBR-STR-018-07, TST-MBR-STR-095
validationservice, databasetest
services-membership:tests/e2e/database-refusals.e2e.spec.ts#mistakes only the database catches, through the API › DEF-MBR-0086: a configuration write a check, a foreign key or an integer column refuses › refuses a type of a program that does not exist 400 naming program_id
08must prove
Proposed
Configuration lists default to 50 records in identifier order and cap oversized requests at 500; activity-filtered package pages can remain continuable even when empty.
proved by ATS-MBR-STR-018-09
calculationapi, serviceobserved
services-membership:modules/configuration/services/persistence/membership-packages.ts:listMembershipPackages
09must prove
Proposed
Another workspace’s record behaves as missing for reads, updates and deletions.
proved by ATS-MBR-STR-018-08, ATS-MBR-STR-019-08, TST-MBR-STR-029
permissiondatabase, serviceobserved
services-membership:aws/api/route-inputs.ts:found
10
Proposed
These configuration operations neither expose nor honor the stored lock flag.
policyserviceobserved
services-membership:modules/configuration/services/persistence/configuration-store.ts:configurationStore
11
Proposed
An unchanged configuration save advances the version without creating a content revision.
policyservicedocumented
react-console:acceptance/membership/journeys/configuration/MBR-ACC-0122.json

Scenarios

IdGivenWhenThenProvenance
01Two staff editors read the same package version.Each submits a change using that original version.The first change saves and the second must reconcile the newer record.test
services-membership:tests/acceptance/configuration/MBR-ACC-0084.acceptance.ts#MBR-ACC-0084: Two administrators edit the Regular package at the same time: the first save wins, the second is told to re-read, and the grants she re-sends get new ids

Edge Cases

IdGivenWhenThenProvenance
02An integration requests 501 configuration records.The configuration list handles the request.The response is limited to 500 without an oversized-request refusal.documented
react-console:acceptance/membership/journeys/configuration/MBR-ACC-0087.json

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software