OpenAPI
Generate the reference, and be told when the API changes.
OpenAPI
Section titled “OpenAPI”Connect an OpenAPI 3.0 or 3.1 document and Staleless generates the reference pages, then watches the document for changes.
Connecting one
Section titled “Connecting one”Four sources: upload a file, give a URL, point at a file in the connected repository, or paste the document.
A URL in the connected repository is usually best. The document is then versioned beside the code that implements it.
What is parsed
Section titled “What is parsed”Servers, tags, paths, methods, operationId, descriptions, parameters, request
bodies, security schemes, examples, responses, schemas, and webhooks where the
document declares them.
Validation problems name the file, the location, the severity and the explanation. A document that will not parse is reported rather than half imported.
What the reference shows
Section titled “What the reference shows”For each operation: method and path, summary, description, authentication, parameters, request schema and example, responses, error models, and links to reusable schemas. Version and deprecation badges where the document declares them.
A large document is loaded lazily and stays searchable.
Syncing
Section titled “Syncing”Manual, or on a schedule. Each sync stores a version of the document, so you can diff any two.
Warning
A sync never silently republishes your reference. A change that affects a page becomes an inbox item. Documentation that changed under a reader without anybody deciding is the failure this avoids.
Change detection
Section titled “Change detection”Every sync diffs the new document against the last and classifies each change:
| Class | Examples |
|---|---|
| Additive | A new operation. A new optional field. |
| Potentially breaking | A changed parameter. A changed response shape. |
| Breaking | A removed operation. A new required field. A changed auth scheme. |
Then it names the pages affected, with the rule that matched and the text it matched on. See Code and API impact.
Coverage
Section titled “Coverage”Staleless also reports the reverse: operations in your document that no page mentions. That list is the most reliable “what is undocumented” answer in the product, because it compares two things you already have rather than asking anybody to maintain a checklist.
Hand-written pages beside it
Section titled “Hand-written pages beside it”A generated reference answers “what are the fields”. It does not answer “how do I do the thing”. Keep guides as ordinary pages and put them in the same navigation section. See API reference pages.