Operations
4 pages filed under APIs › operations. An operation is one call of an API, with its parameters and its responses as the contract declares them.
| Operation | Method | First line | Links |
|---|---|---|---|
| List the entities | GET | Returns the entities of the last build, in identifier order, with the same fields as the entities block of the model; a screen that cannot read model.json directly will page through them here. The operation is declared by the OpenAPI contract of the model query API and exists nowhere else in this version. | 35 |
| Suggest links | Proposes the links a note could write, from the candidates of the last build: the objects a contract names without a note and the expressions the scan recognised without a definition. The model query API does not declare the operation yet: this note is ahead of its contract, which the operation unmatched rule reports until the contract catches up, and the API page lists it among the gaps, described, absent from the contract. | 21 | |
| Get an entity | GET | Returns one entity of the last build by its identifier, with its attributes, its displayed neighbourhood and the links it is an end of, as the entity page shows them. Declared by the OpenAPI contract of the model query API; nothing of it exists in the command line. | 13 |
| Search the model | GET | Returns the entities matching a query, scored as the search island of the site scores them, for a client that does not load the search index. Declared by the OpenAPI contract of the model query API; the static search of the site does not depend on it. | 12 |
4 operations of 4 — pagination by twenty. The Links column counts the related pages, which brings the most central operations of the journey to the top.