DerManoMann / openapi-introspector / 38677948919

98%

push

github

Keep documented operations when routes collide with them (#6)

Stacked on #5, so this targets `fix/placeholder-names` until that is
merged.

## Overview

Two ways a route's bare operation replaced a documented one at the same
method and path:

- **Operations stacked on one method.** `routeOf()` took the handler's
only route without comparing paths. Where a method carries operations
for several routes, each was paired with that method's own route, and
the route its path names was added bare over it.
- **A route at a path documented for another route.** With attribute
paths written relative to a server URL (`/accounts` under `.../api`), a
web route at `/accounts` sits exactly where the API operation is
documented.

## Changes

- `Introspector::routeOf()` only pairs an operation with its handler's
route where the paths agree: the same path, or the route's path ending
with the operation's, segment by segment. A route placeholder matches
any segment, so renamed placeholders and a literal such as `me` still
agree. A placeholder in the attribute does not match a literal in the
route. The route may have more leading segments, so a path relative to a
server URL still pairs with its handler
- A route at a path an attribute operation documents for another route
is left out, whether it would be contributed bare or the translator made
an operation for its handler
- `Status::Conflict` records it, and the builder's logger gets a warning
naming both
- `IntrospectionAugmenter` takes the pipeline's logger, and
`Introspector::introspect()` an optional one
- `psr/log` is required directly, since `src/` now uses it
- README: `Conflict` in the inventory table, with its usual cause
- `FoldTest` covers stacked operations, both conflicts and a placeholder
against a literal segment

39 of 39 new or added lines in 2 files covered. (100.0%)

344 of 357 relevant lines covered (96.36%)

15.44 hits per line