diff mbox series

[layerindex-web,08/10] README.md: fix the REST API note, a JSON example and a typo

Message ID 20261018220308.72731-9-tim.orling@konsulko.com
State New
Headers show
Series Documentation updates; README files as Markdown | expand

Commit Message

Tim Orling Oct. 18, 2026, 10:03 p.m. UTC
The security notes said the REST API had been disabled because it has
no access controls. It is enabled: it is read-only, needs no login and
serves the published layer data, including maintainer email addresses,
to tools such as bitbake-layers layerindex-fetch and Toaster. Say so.

Also add the missing quote in the /etc/docker/daemon.json example and
drop a doubled "the".

AI-Generated: Claude Opus 5.5
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 README.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/README.md b/README.md
index d33bb5d..e53ddfa 100644
--- a/README.md
+++ b/README.md
@@ -121,7 +121,7 @@  Other settings the app and celery files can set:
   `/etc/docker/daemon.json`:
 
   ```json
-  {"dns": ["xx.xx.xx.xx] }
+  {"dns": ["xx.xx.xx.xx"]}
   ```
 
 
@@ -473,12 +473,12 @@  Some things to be aware of from a security perspective:
 
   - By account for too many incorrect password reset attempts. To remove
     this lockout, log into the admin interface, go to Users, click on the
-    the user, tick the Active checkbox and then save.
+    user, tick the Active checkbox and then save.
 
-- The REST API inherited from the OpenEmbedded layerindex upon which this
-  application is based has been disabled, since it has no access controls
-  on querying data (since the OE layer index operates entirely on publicly
-  accessible information, whereas this application may not in actual usage).
+- The REST API at `/layerindex/api/` is read-only and needs no login. It
+  serves the same information as the public web pages for published layers,
+  including the names and email addresses of layer maintainers, and is used
+  by tools such as `bitbake-layers layerindex-fetch` and Toaster.
 
 
 ## Backup and restore