Contracts
2 pages filed under Inference › contracts. A term is a word of the business with its definition, its aliases and the words it relates to.
| Term | aliases | First line | Links |
|---|---|---|---|
| Contract | interface contract, API contract | The machine-readable description of an API that a note declares in its contract attribute, as a URL or a path: an OpenAPI 3 document or a WSDL. The build imports it through a plugin, produces one operation per operation it declares, caches it by the fingerprint of its bytes and records its title, version and import date in the model. The page of the API shows the contract without copying it into the note: its operations as a plain list, a link to download the original, and a viewer that loads the signatures and schemas on demand. | 135 |
| Operation | endpoint, operation note | One callable unit of an API: a method and a path in an OpenAPI contract, a port and an operation name in a WSDL. The build imports every operation of a declared contract as an endpoint entity with the properties the contract states. An author who has business to explain writes an operation note; the build attaches it to the imported operation on its declared identifier, then on its method and path, then on its title, and the note becomes the single page of the operation, showing its own markdown, the properties of the contract and its own links. | 82 |
2 contracts of 2 — pagination by twenty. The Links column counts the related pages, which brings the most central contracts of the journey to the top.