Model query API

APISpace Specifications

The HTTP (4 passages, no note) face of the future long (3 passages, no note)-running service: it answers questions about the model of the last build (note: Build) for the screens (note: Screen) that cannot read model.json directly. Nothing of it exists in the command (21 passages, no note) line of this version; the contract (note: Contract), an OpenAPI 3.1 document (note: Document) kept next to this note (note: Note), declares four operations (note: Operation), listEntities (GET /entities), getEntity (GET /entities/{id}), searchModel (GET /search) and listFindings (GET /findings), and four schemas (31 passages, no note), Entity, Link, Finding and SearchHit. The build imports the operations (4 passages, no note) as operations of this API (note: API) and attaches to each one the operation note that describes it, following the operation matching rule; an operation left without a note, listFindings today, keeps the properties (note: Attribute) of the contract only, and a note the contract (4 passages, no note) does not declare yet, suggest links, stays ahead (3 passages, no note) of it until the next version. The API page states (36 passages, no note) both gaps (8 passages, no note) and shows the contract in its viewer (55 passages, no note).

Consumers

Objects

Operations

Matched to the contract by operation name. The rows in italics are gaps: present in the contract without a page, or described without existing in the contract.

MethodPathOperationCallers
GET/entitiesList the entities3 callers
GET/entities/{id}Get an entity1 caller
GET/searchSearch the model1 caller
GET/findingsGET /findingspresent in the contract, without a page
unknown pathSuggest linksdescribed, absent from the contract

Interface contract

openapi 3.1contracts/model-query.openapi.json

Contract data (JSON)

No schema is copied into the text: the page shows the contract, it does not duplicate it.

Download the contract

Properties5

Protocol
rest
Exposure
internal
Version
1
Status
draft
Contract
contracts/model-query.openapi.json

Five keys, no more. The operations come from the contract, not from the header.

See the neighbourhood map6 pages6Neighbourhood mapModel query API

Neighbourhood map Model query API

Distance1 hop

Neighbourhood map. The list below carries the same information as the map.existing pageword without a note

44 neighbours in total, more than the map shows.

textual equivalent

Six neighbours at most, always named. Beyond that the map teaches nothing: the list takes over.