Stone.js API
    Preparing search index...
    • The path a route was declared with, in the syntax a contract speaks.

      A route's path is the pathname of the event it is answering, so with no event bound it is /: every documented endpoint collapsed onto the root and the document described one nameless operation instead of an API. The declared template is what a route is; the event is what it met.

      The template is then translated, because the two syntaxes are not the same one. A :id segment means nothing to a specification reader, and a path parameter that appears in a template must also be declared, or the document is invalid however right the path looks. An optional segment yields the path with and without it, since OpenAPI has no optional path parameter and would rather have two honest paths than one that lies about being required.

      Parameters

      Returns { parameters: Record<string, unknown>[]; paths: string[] }

      The path(s) to document, and the parameters the template requires.