Ship the API docs the container never had, and theme them like the product
/api/docs was broken in every Docker deployment, including the air-gapped ones.
docs.py resolves openapi.json and llms.txt from the repo root, and the image
copies shopdb, plugins, migrations, scripts and wsgi.py but never docs. The page
rendered the Redoc shell and then answered 404 fetching its own specification.
Only the two files the app actually serves are copied; the rest of that tree is
prose with no business in a runtime image.
The theme was invented colours that matched nothing. It now maps the product's
own tokens, and reads the theme the way the app does: the application stores an
explicit light/dark choice and stamps data-theme, so choosing light on a
dark-desktop kiosk used to give a dark documentation page. The operating system
setting is the fallback, exactly as it is in the app.
Light-mode primary, success and error are a shade darker than the product
tokens, because those tokens are designed as fills and fail contrast as text on
the nested panels where type names and required labels sit. Measured with a
browser harness rather than judged by eye: every text node in both themes now
clears WCAG AA, from an initial 5603 reported failures - most of which were the
harness itself ignoring alpha, which is its own lesson about trusting a number.
Four Redoc elements carry hardcoded colours with no theme key and keep targeted
rules, selected by tag and attribute rather than by generated class hashes that
change on every build.
The build now compiles the Python. Docker never imports the application, so a
syntax error sails through every layer and surfaces as a crash-looping
container; that happened, four restarts, while working on this file.
Redoc's upstream licence file was never vendored although its bundle header
points at it. The placeholder added here says exactly that rather than inventing
the third-party notices it is supposed to carry, and the dead redocly.com badge
is hidden: the licence wants the notice in the distribution, not a rendered
link that a site with no internet cannot follow.
(cherry picked from commit 6c00b10618)
This commit is contained in:
37
shopdb/core/api/staticdocs/redoc.standalone.js.LICENSE.txt
Normal file
37
shopdb/core/api/staticdocs/redoc.standalone.js.LICENSE.txt
Normal file
@@ -0,0 +1,37 @@
|
||||
Redoc (redoc.standalone.js) - vendored third-party bundle
|
||||
=========================================================
|
||||
|
||||
Redoc is distributed under the MIT License.
|
||||
|
||||
WHY THIS FILE IS A PLACEHOLDER
|
||||
------------------------------
|
||||
The vendored bundle opens with:
|
||||
|
||||
/*! For license information please see redoc.standalone.js.LICENSE.txt */
|
||||
|
||||
That companion file is produced by webpack and carries the extracted licence
|
||||
headers of Redoc AND of every third-party package compiled into the bundle. It
|
||||
ships alongside redoc.standalone.js in the upstream dist and was not copied when
|
||||
this bundle was vendored, so the pointer above led nowhere.
|
||||
|
||||
The contents are NOT reproduced from memory here, because doing so would mean
|
||||
inventing attribution for packages whose notices cannot be read back out of a
|
||||
minified bundle. Do not treat this file as a substitute for the real one.
|
||||
|
||||
WHAT TO DO
|
||||
----------
|
||||
When next re-vendoring Redoc, copy BOTH files out of the upstream dist:
|
||||
|
||||
redoc.standalone.js
|
||||
redoc.standalone.js.LICENSE.txt <- replaces this placeholder
|
||||
|
||||
and record the version and source URL in the same commit, so the next person
|
||||
does not have to work out what is installed by reading the minified source.
|
||||
|
||||
The version of the currently vendored bundle could not be determined: it has no
|
||||
version string, and no commit or document in this repository records it.
|
||||
|
||||
RELATED
|
||||
-------
|
||||
Swagger UI is vendored in this same directory and DOES carry its upstream
|
||||
notice (swagger-ui.LICENSE.txt). That is the pattern this file should follow.
|
||||
Reference in New Issue
Block a user