diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/access.md | 3 | ||||
| -rw-r--r-- | docs/dashboard.md | 5 | ||||
| -rw-r--r-- | docs/openapi.yaml | 27 |
3 files changed, 32 insertions, 3 deletions
diff --git a/docs/access.md b/docs/access.md index a4c5375..38ae180 100644 --- a/docs/access.md +++ b/docs/access.md @@ -172,7 +172,8 @@ it may do. Pages of other origins, the dashboards of other members, may call a node with a token: its own links (`/admin/dashboard/links/own`, and its events) and messages -(`/admin/dashboard/messages/own/events`), `/auth/refresh` and `/auth/whoami`, nothing +(`/admin/dashboard/messages/own/events`, and one written out, +`/admin/dashboard/messages/own/{seq}`), `/auth/refresh` and `/auth/whoami`, nothing else. A node allows the origins of the dashboards its member list names (`--dashboard-url`) and those of `--cors-origins`; without credentials (no cookie or password crosses origins: the page sends its token). diff --git a/docs/dashboard.md b/docs/dashboard.md index 5eee5c9..590f72f 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -399,8 +399,9 @@ A subscribed node's messages with its peers are listed too, as they come from it named by both ends, the receiver first (`b ← a`), each once, as on the map (those with this node only from this node, between two subscribed nodes from the sender); its tooltip names the node that logged it. Shown in the figures box, it says when, both -ends, its type and size: the message itself is written out only on the node that -logged it. +ends, its type, size and address, and the message written out, read from the node that +logged it as it is shown (`/admin/dashboard/messages/own/{seq}` there, with the page's +token), while that node still keeps it (its latest 1000). A click on a message shows it in the figures box: when, with whom, its type and size, and the message written out (its bytes as sizes). A click on it again, or on anything on diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 0fad136..03afa2f 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -1293,6 +1293,33 @@ paths: '401': $ref: '#/components/responses/Unauthorized' + /admin/dashboard/messages/own/{seq}: + get: + tags: [Admin] + summary: One of this node's messages, written out + description: | + The message `seq` (its number in `messages/own/events`) written out, as this + node's own console shows it, for a page subscribed to this node showing it (CORS, + with a token). Kept while the message log is: the latest 1000, while one looks. + parameters: + - name: seq + in: path + required: true + schema: { type: integer } + responses: + '200': + description: The message written out. + content: + application/json: + schema: + type: object + properties: + text: { type: string } + '401': + $ref: '#/components/responses/Unauthorized' + '404': + description: Not kept any more. + /admin/dashboard/refresh: post: tags: [Admin] |