[AC-532] Updates to the PRD-4.1 Document by stephenfuqua · Pull Request #265 · Ed-Fi-Alliance-OSS/Ed-Fi-AdminApp

stephenfuqua · 2026-07-20T14:43:10Z

Adds Data Store Instance Management as a job-to-be-done, with associated requirements
Updates terminology
Update the Compose folder to use ODS/API 7.3.2
Opportunistically, removes the unused Cypress dependency

stephenfuqua · 2026-07-20T14:45:18Z

-
-> [!NOTE]
-> In the future "ODS Instances" will have a different name, applicable as well
-> to Ed-Fi API v8. But this is the given name as of Admin App version 4.0.


Removed this section because (a) it has a hallucination and (b) ODS Instance management was only enabled in SBAA mode.

github-actions · 2026-07-20T14:51:40Z

Test Results

5 files 151 suites 3m 39s ⏱️
779 tests 779 ✅ 0 💤 0 ❌
855 runs 855 ✅ 0 💤 0 ❌

Results for commit c8adeb5.

♻️ This comment has been updated with latest results.

roberthunterjr · 2026-07-27T22:45:12Z

+  "_FeatureManagement":"MultiTenancy is the correct setting for ODS/API 7.3.2",
+  "FeatureManagement": {
+    "MultiTenancy": true
+  },
+  "_ApiSettings":"Features:11:IsEnabled is the correct setting for ODS/API 7.3.1",


I am interpreting this to mean 7.3.2 should be the default to support out of the box. Does this mean we need to provide guidance for setting to false for those who are using an earlier version of the ODS/API?

7.3.2 is the new default, which is reflected in the .env.example settings. This file, however, will work with either 7.3.1 or 7.3.2 without modification.

roberthunterjr · 2026-07-27T22:45:28Z

+  "_FeatureManagement":"MultiTenancy is the correct setting for ODS/API 7.3.2",
+  "FeatureManagement": {
+    "MultiTenancy": true
+  },
+  "_ApiSettings":"Features:11:IsEnabled is the correct setting for ODS/API 7.3.1",


Same as above.

The file covers both versions. Let me know if there is anything else you would like to see here.

roberthunterjr · 2026-07-27T23:02:09Z


 The application SHALL support synchronization between the Admin
-App database and running Ed-Fi ODS/API v7+ and ODS Admin API instances that are not
+App database and running Ed-Fi ODS/API v7+ and Management API instances that are not


Do we still want to explicitly (or implicitly) support Starting Blocks Environments. We have not synced code since the original fork and may not make a lot of sense to do so at this point.

We have been trying to keep the Starting Blocks code unchanged. The problem is that we are not able to actually test this since we don't have access to their lambda functions in AWS.

In the context of this pull request, the code will still have the SBE support. For now, we just have to assume the SBAA code is working without actually testing it.

We do have access to the lambda function if we ever wanted to test it out, by the way. We would just have to modify edanalytics/startingblocks_oss to deploy our version of Admin App instead of theirs.

Copilot

Pull request overview

Updates the Admin App v4.1 product requirements documentation and refreshes local Compose-based development configuration to align with ODS/API 7.3.2, while also removing unused Cypress tooling dependencies from the repository’s Node workspace.

Changes:

Expanded/updated PRD v4.1 with Management API terminology and added Data Store Instance Management (JTBD 8) requirements.
Updated Compose templates and example environment configuration for ODS/API 7.3.2 and refreshed template download guidance.
Removed Cypress-related devDependencies (and corresponding lockfile entries).

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
package.json	Removes Cypress-related devDependencies.
package-lock.json	Lockfile updates corresponding to dependency removals/metadata changes.
docs/PRD-AdminApp-v4.1.md	Adds/updates PRD content (Management API terminology, JTBD 8 + functional/NFR updates).
docs/PRD-AdminApp-v4.0.md	Removes the v4.0 “ODS Instance Management” section and adjusts JTBD heading formatting.
compose/settings/appsettings.v3.dockertemplate.json	Adds FeatureManagement MultiTenancy setting for ODS/API 7.3.2 (plus inline “comment” keys).
compose/settings/appsettings.v2.dockertemplate.json	Adds FeatureManagement MultiTenancy setting for ODS/API 7.3.2 (plus inline “comment” keys).
compose/readme.md	Updates template download links and clarifies template extraction steps.
compose/.env.example	Updates ODS/API tag and Admin API DB/API tag guidance for the 7.3.2 stack.
CLAUDE.md	Adds consolidated coding-agent instructions document.
AGENTS.md	Points agents to CLAUDE.md for the canonical instructions.

Suppressed comments (1)

docs/PRD-AdminApp-v4.1.md:335

FR-DBINST-16 uses “an Data Store instance…”, which should be “a Data Store instance…”.

- **FR-DBINST-16:** Once an Data Store instance delete operation completes successfully,
  the application SHALL reflect the **Deleted** status in the Data Store instance list
  and detail page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Add FR-ODS-4 through FR-ODS-11 covering non-Starting Blocks ODS creation via the Admin API v2 dbinstances endpoint, pending-status records with async sync-job queuing, fixed database template options, relaxed name validation, and list-refresh behavior. Update architecture implications and glossary to match. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

#241 Capture PR #241's ODS list/detail metadata (type, status, database name) persistence and sync-delta behavior as FR-ODS-12 through FR-ODS-15, and add FR-ODS-16 through FR-ODS-20 for the planned delete flow, matching the existing create pattern and the status vocabulary already used in the UI. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

…iles

…agement in v4.0.

… was actually out of scope in 4.0

…h "Data Store"

E2E tests use Playwright/Gherkin, not Cypress; LF line endings are enforced via .gitattributes, not .editorconfig; commit message format was missing the feat:/perf:/build:/ci: prefixes actually in use. Also documents the Node >=24 engine requirement and two undocumented npm scripts (migrations:run:mssql, test:e2e:bdd). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

cypress, @nx/cypress, and eslint-plugin-cypress had no config, project targets, spec files, or CI usage anywhere in the repo -- E2E testing runs on Playwright/Gherkin instead. Confirmed npm run build still passes after removal. Also updated Babel dev dependencies to 8.x for consistency. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Nx's babel tooling (@nx/react, @nx/js) hard-requires Babel ^7.x, so a prior dependency bump to @babel/core, @babel/preset-react, and @babel/preset-typescript 8.0.1 broke `nx run fe:test` with a Babel version-mismatch error. Also add a Dependabot ignore rule for @babel/* major updates so this can't recur automatically. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

stephenfuqua commented Jul 20, 2026

View reviewed changes

roberthunterjr reviewed Jul 27, 2026

View reviewed changes

DavidJGapCR reviewed Jul 30, 2026

View reviewed changes

Comment thread docs/PRD-AdminApp-v4.1.md Outdated

stephenfuqua requested a lite review from Copilot August 4, 2026 17:45

Copilot started reviewing on behalf of stephenfuqua August 4, 2026 17:47 View session

Copilot AI reviewed Aug 4, 2026

View reviewed changes

stephenfuqua force-pushed the PRD-4.1-updates branch 2 times, most recently from bb29f59 to 3d60948 Compare August 4, 2026 20:30

stephenfuqua requested a review from a team as a code owner August 4, 2026 20:30

DavidJGapCR approved these changes Aug 5, 2026

View reviewed changes

roberthunterjr approved these changes Aug 6, 2026

View reviewed changes

stephenfuqua and others added 14 commits August 6, 2026 20:11

docs: Provide more information about minimal and populated template f…

f2d6523

…iles

chore: Update to ODS/API 7.3.2

fd4ec19

fix: Correction - Ed-Fi Admin App does _not_ support ODS database man…

b56bcf0

…agement in v4.0.

docs: Update ODS Instance Management, reflecting that this capability…

8ed0971

… was actually out of scope in 4.0

doc: Replace "Admin API" with "Management API" and "ODS Instance" wit…

bee17ca

…h "Data Store"

chore: Update v3 docker template to match v2 docker template

4b94bc8

chore: Rename file

5a9b54a

docs: Clarifications based on code review

b9ca2a6

fix: Resolve Copilot review comments

b045129

stephenfuqua force-pushed the PRD-4.1-updates branch from 3d60948 to c8adeb5 Compare August 7, 2026 01:15

Uh oh!

Conversation

stephenfuqua commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

stephenfuqua commented Jul 20, 2026 •

edited

Loading

github-actions Bot commented Jul 20, 2026 •

edited

Loading