Skip to main content

Module wiki

Module wiki 

Source
Expand description

Yandex Wiki: a second host reached with the same account and organisation.

The Wiki takes the token and the organisation header Tracker does, so one client carries both and only the address differs (docs/adr/0007-yandex-wiki.md). Pages are addressed by slug — the path in their URL — because that is what anyone has to hand.

Structs§

AccessEntry
One grant: a role, held by a user or a group.
CursorPage
One page of a Wiki listing.
GridColumn
GridQuery
What to read of a grid. The Wiki does the filtering, so a narrow question costs a narrow answer.
GridRow
OperationStatus
Where an operation has got to.
UploadSession
An upload the Wiki has opened for one file.
WikiAccess
Who can read and edit a page, in our schema.
WikiAttachment
A file attached to a page, in our schema.
WikiComment
One comment, in our schema.
WikiGrid
One dynamic table, in our schema.
WikiGridRef
A grid named by a listing.
WikiHit
One search hit: a page, or a file attached to one.
WikiHits
A page of search hits.
WikiOperation
Work the Wiki does after it has answered: a clone.
WikiPage
One page, in our schema.
WikiPageRef
A page named by a listing: the Wiki sends its id and slug, and no title.
WikiResource
One thing a page holds: a file or a grid, told apart by kind.
WikiRestored
A page brought back from deletion.

Enums§

CommentScope
Which comments to list.

Constants§

DEFAULT_WIKI_URL
Default Wiki API root. Overridable so tests can point at a wiremock server.
LAST_SEARCH_PAGE
The last page of hits the Wiki’s search will serve.
UPLOAD_PART
The size of each part of an upload but the last.

Functions§

slug_of
The slug in whatever was pasted: a slug already, or a page’s full address.
upload_parts
The byte ranges an upload of len bytes is sent in: one part for a file smaller than a part, otherwise parts of size and a shorter last one.