ge-aerospace/shopdb-flask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Record the documentation and API-surface sweep in the changelog

Browse Source
This commit is contained in:
cproudlock
2026-08-14 16:21:16 -04:00
parent 96df19702e
commit 1d8c983d04
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CHANGELOG.md
View File

@@ -83,6 +83,12 @@ ADR-007 and ADR-002.
returning nothing and leaving the caller to guess. returning nothing and leaving the caller to guess.
- The display client module updates itself through the manifest, so a client - The display client module updates itself through the manifest, so a client
change no longer means hands on every kiosk. change no longer means hands on every kiosk.
- `docs/START-HERE.md` routes a reader by what they came to do, and is now the
wiki's landing page - which previously recommended the one install document
the docs themselves forbid for a new site. `docs/FLEET-ARCHITECTURE.md` is the
page nothing else could assume: how the server, GE-Enforce, the asset
reporter, the backup collectors and EventSaver relate, where credentials live
at both ends, and which of the five to open for a given symptom.
- `docs/ADOPTING-AT-ANOTHER-SITE.md`: how another site repoints the asset - `docs/ADOPTING-AT-ANOTHER-SITE.md`: how another site repoints the asset
reporter and the EventSaver screensaver at its own ShopDB, with worked reporter and the EventSaver screensaver at its own ShopDB, with worked
examples for Intune (including Machine Configuration/DSC), a GE-Enforce examples for Intune (including Machine Configuration/DSC), a GE-Enforce
@@ -127,6 +133,18 @@ ADR-007 and ADR-002.
### Fixed ### Fixed
- Documentation a reader could not follow. 98 curl examples single-quoted
`$TOKEN`, so the shell never expanded it and the server answered 422; a JSON
body carried a `//` comment, which made the server report a missing hostname
about a body that has one; the IIS install omitted `flask plugin upgrade-all`,
which is the 1054 error a deploy hits days later; a pilot loop exited 1 on
every iteration; and the external-plugin guide pinned a contract version six
releases stale, so a plugin built by following it is refused at startup. Nine
documents now point at the generated project map rather than typing a version,
and a test enforces that. The API inventory gained the 22 routes that were
serving traffic undocumented, with a parity test against the live URL map so
the next one cannot slip in silently.
- **Every plugin migration chain re-ran its head on each MySQL deploy.** Core's - **Every plugin migration chain re-ran its head on each MySQL deploy.** Core's
Alembic env got a `connection.commit()`; the per-plugin template did not, so Alembic env got a `connection.commit()`; the per-plugin template did not, so
the last migration of every run lost its version stamp while its DDL survived. the last migration of every run lost its version stamp while its DDL survived.