2  What the platform does

The 196 operations fall into 30 families. A family is a group of operations over one kind of thing: everything you can do to a dataset, or to an image, or to an organisation’s membership.

The distribution is itself a description of the product. The three largest — Datasets (27), Images (23), Equipment (13) — say plainly what KAP is: a system for organising field imagery into campaign datasets and working through what is in them.

Family Operations
Datasets 27
Images 23
Equipment 13
Notes 11
Organizations 10
integrity 10
Chat Sessions 9
MCP 9
Storage 9
Annotations 8
Authentication 8
Debug 8
CAD Viewer (APS) 6
equipment 6
Chat 4
Gas Readings 4
health 4
integrity-contract 4
Reports 3
System 3
Thumbnails 3
Anomalies 2
CAD 2
Gallery 2
Render 2
agui 2
TTS 1
Worklist 1
iow 1
systems 1

2.1 How to read a family

Each family is one chapter. Within it, every operation states:

  • its address — the method and path a client calls;
  • why it exists — one line, marked † when it was assembled mechanically rather than written by whoever decided the operation should exist;
  • what it takes — path, query and body parameters, and which are required;
  • what it returns — the field names the handler actually produces, not the status code;
  • its effect — the database tables it reads, and the verbs it writes with;
  • its access rule — the declared authentication, and whether it bypasses row-level security.

The last two are the ones a specification alone cannot give you, and they are read out of the handlers rather than asserted.