Skip to content

Docs: drasi-platform REST API endpoints undocumented alongside drasi-server endpoints #427

Description

@clubanderson

Summary

Small quality-of-life doc gap related to issue #426 but scoped specifically to the drasi-platform drasi-api in-cluster Service.

Today, there's no single page listing the actual HTTP endpoints served by drasi-api.drasi-system.svc:8080. I had to discover them by probing:

GET /v1/sources                → array of source summaries
GET /v1/continuousQueries      → array of query summaries
GET /v1/reactions              → array of reaction summaries
GET /v1/sourceProviders        → installed source provider list
GET /v1/reactionProviders      → installed reaction provider list
GET /v1/queryContainers        → storage/compute pool info

None of these are documented in the main drasi-project docs I could find. The CLI uses them internally but the docs route users at the CLI layer exclusively, which leaves integrators with nothing to point their clients at.

Request

Add a "drasi-platform REST API reference" page listing:

Happy to draft this as a PR if maintainers would accept it — I have captured response shapes from a real install.

Context

Integrating Drasi into the KubeStellar Console. Wrote the adapter by reading the drasi-api Rust source — doable, but every future ecosystem adopter will have to do the same unless the endpoints get documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions