The page of an interface (21 passages, no note) whose contract the build imported (3 passages, no note). Same shell as the entity page, laid out at the grain an interface is worked at: its operations (note: Operation). The tree (47 passages, no note) lists them under the interface, a table (40 passages, no note) matches (note: Occurrence) them to the contract (note: Contract) and states (36 passages, no note) the gaps (8 passages, no note) between the contract and the notes, the contract (4 passages, no note) stands in a block of its own, shown and never copied into the text, and the panel (97 passages, no note) keeps five keys (46 passages, no note) and lifts the operations to the top of the related pages (note: Related page). An API (note: API) without an imported contract keeps the generic entity page.
Today
The page of an api note (note: Note) at <id>/index.html stands on the three regions of the entity page. On the left, the tree of the space (note: Space) with the current interface ruled and bold and its operations listed under it, in the order of the contract as its reader (note: Reader) lists it, the paths sorted for an OpenAPI document (note: Document), whatever folder their notes are filed in. In the centre, the breadcrumb (3 passages, no note), the title and the line naming the type (3 passages, no note), when the note last changed and the space, without any highlighted property (note: Attribute): the properties wait in the panel. The note follows at full column (25 passages, no note) width, with its legend.
Under the note, "Operations", led by "Matched to the contract by operation name." One row (41 passages, no note) per operation the import (25 passages, no note) attached to a note, in the order of the contract, the same as the tree: the method (28 passages, no note) as a chip (20 passages, no note), DELETE and OPTIONS abbreviated with their full name kept for assistive technology, the path in the monospace family (4 passages, no note), the title of the operation note linked to its page, and how many pages cite (31 passages, no note) the operation, "N callers", the same count as the related pages of that operation. Then the gaps, in italics (3 passages, no note) on the soft surface (3 passages, no note), and the lead says what the italics mean, a sentence (25 passages, no note) present only when the table holds a gap: an operation the contract declares that no note describes, unlinked, marked "present in the contract, without a page"; and an operation note the contract does not declare, the notes the operation unmatched rule reports, linked, with a hollow chip and "unknown (4 passages, no note) path" when the note declares neither, marked "described, absent from the contract". The rows are text in the served page; a contract without any operation says so.
"Interface contract" follows as a card (11 passages, no note): on its first line the format (16 passages, no note) the import recorded (openapi 3.1, wsdl 1.1), the file the note names and, at its end, "imported (27 passages, no note) N days ago", the last change of the contract file relative to the build (note: Build), from the history (9 passages, no note) of its repository (note: Knowledge repository), never the instant of the build (3 passages, no note); under it the contract viewer, open in the page as soon as its script (37 passages, no note) runs, a link (note: Link) to its JSON view (48 passages, no note) until then, and the note that no schema (31 passages, no note) is copied into the text: the page shows the contract, it does not duplicate (10 passages, no note) it; at the foot (10 passages, no note) of the card the link that downloads (30 passages, no note) the original. The path of the file and its edit link close the column.
The right panel keeps three blocks. "Properties" lists five keys, no more, the properties the profile (note: Profile) highlights (3 passages, no note) for the type (note: Type) first, in that order, then the declared ones, with the note that the operations come from the contract, not from the header (9 passages, no note). "Related pages" is the mentions panel with the operations first whatever their passage (note: Passage) count, since the notes describing (3 passages, no note) them name the interface at the top of their file, then the other pages by number of passages, and the note "On an interface the operations rise to the top: that is the grain we work at." Last, the neighbourhood map (note: Neighbourhood map) folded behind its line. There is no table of contents (7 passages, no note).
Objects
Actions
- Open an operation → entity page
- Open a related page → entity page
- Download the contract (3 passages, no note) → the declared URL or the copy next to the page
- Read the contract → contract viewer, open in the page