Repository navigation
[O2B-1623] Document the detectors endpoint in the HTTP API documentation - #2264
Merged
Merged
Conversation
graduta
added this pull request to stack #2265
October 20, 2026 12:55
graduta
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2264 +/- ##
=======================================
Coverage 46.38% 46.39%
=======================================
Files 1053 1053
Lines 17384 17384
Branches 3168 3168
=======================================
+ Hits 8064 8065 +1
+ Misses 9320 9319 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Base automatically changed from
feature/O2B-1623/docs-configuration-endpoint
to
main
October 22, 2026 08:43
graduta
force-pushed
the
feature/O2B-1623/docs-detectors-endpoint
branch
from
October 22, 2026 08:44
d1c77c1 to
30b596e
Compare
`GET /api/detectors` sent the creation and update dates of each detector, which nothing uses: the GUI only reads the type and the name through `detectorsProvider` and the dates are not part of any other consumer of `DetectorAdapter.toEntity`. The adapter now only returns `id`, `name` and `type`, the `Detector` typedef is updated accordingly (and gets its missing `id`), and the API test checks the keys of the returned detectors.
graduta
force-pushed
the
feature/O2B-1623/docs-detectors-endpoint
branch
from
October 22, 2026 08:52
30b596e to
a545ba4
Compare
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). The earlier PRs of the stack (#2261, #2262, #2263) are merged: this one is rebased on
mainand regenerated with the current generator. The following PRs of the stack are rebased one by one, once the previous one is merged.Notable changes for users:
detectorsendpoints are now documented at/api-docs, with parameters, responses andcurlexamples:GET /api/detectors: all detectors sorted by name, with their type.createdAtandupdatedAtare no longer returned (see below)Notable changes for developers:
DetectorAdapter.toEntity(only used byGET /api/detectors) no longer returnscreatedAtandupdatedAt: nothing uses them (the GUI only readstypeandnameindetectorsProvider). TheDetectortypedef is updated and gets its missingid. The API test checks the returned keys.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