Repository navigation
Conversation
Describe the tags endpoints (list, create, get by id or name, update, delete, logs of a tag) with parameters, schemas, errors, required roles and examples. Operations that change data are flagged `x-llm-exclude: true`, and the spec carries instructions for LLMs (always paginate, 100 items max).
`npm run docs:api` builds `API.md` (Markdown with curl examples) and `index.html` (styled page, collapsible endpoints) from the OpenAPI spec. - Fails when a non-GET operation does not declare `x-llm-exclude` - Spec content is treated as untrusted when rendering: raw HTML is escaped, unsafe link schemes are dropped, and values put in curl examples are shell-quoted - New devDependencies `js-yaml` (already in the lockfile through eslint) and `marked`, pinned to a release older than two weeks
Serve the generated HTML page (`/api-docs`), the Markdown version for LLMs (`/api-docs/API.md`) and the spec (`/api-docs/openapi.yaml`). The files live under `lib/server` so that they are part of the Docker image.
- `GET /tags/:tagId/runs` was declared twice: once with a controller answering 501 and once with `TagsController.patchRun`, which does not exist, so the binder silently skipped it - `GET /tags/:tagId/log` answered 501 as well None of them is used by the GUI or covered by tests, and none did anything but advertise endpoints that do not exist. They now answer 404 like any unknown route. The matching `getRuns` and `patchLog` stub controllers are removed.
… not a function The route binder silently skipped routes whose controller was undefined (for example a typo or a missing export, as with the removed `GET /tags/:tagId/runs`). It now throws, naming the route. Nodes that only group children, such as `/statistics` and `/dpl-process`, are not affected. Unit tests check that every declared route binds, that grouping nodes are ignored, and that undefined controllers (alone or inside a list) are rejected.
Add GET /status/database and GET /status/gui, and reword the work-in-progress note now that more than one resource is documented.
graduta
added this pull request to stack #2265
October 20, 2026 12:56
graduta
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## feature/O2B-1623/docs-detectors-endpoint #2266 +/- ##
============================================================================
- Coverage 46.47% 46.46% -0.01%
============================================================================
Files 1053 1053
Lines 17359 17359
Branches 3162 3162
============================================================================
- Hits 8067 8066 -1
- Misses 9292 9293 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
graduta
force-pushed
the
feature/O2B-1623/docs-detectors-endpoint
branch
2 times, most recently
from
October 22, 2026 08:52
30b596e to
a545ba4
Compare
Base automatically changed from
feature/O2B-1623/docs-detectors-endpoint
to
main
October 22, 2026 09:00
Member
Author
|
Closing: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I have a JIRA ticket
Part of a stack of PRs documenting the HTTP API (O2B-1623), each PR builds on the previous one: see the stack on GitHub. The first PR of the stack is #2261, which adds the generator and the
/api-docspage.Notable changes for users:
dpl-detectorsendpoints are now documented at/api-docs, with parameters, responses andcurlexamples:GET /api/dpl-detectors: all detectors as seen by the DPL processes (same entities as/api/detectors, without type)Notable changes for developers:
lib/server/api-docs/openapi.yamlis updated by hand,API.mdandindex.htmlare regenerated withnpm run docs:api(separate commit).Changes made to the database:
🤖 Generated with Claude Code