/vehicles:
get:
operationId: get-vehicles
description: Get a list of known vehicles, with properties that do not change often.
summary: Get near-realtime vehicle information.
In the Stoplight menu, this looks like (notice some items are cut off):
Instead reuse the endpoint name in the summary field:
/vehicles:
get:
operationId: get-vehicles
description: Get a list of known vehicles, with properties that do not change often.
summary: /vehicles
This will reduce duplication within these OpenAPI docs and with the MDS docs, and it makes it much clearer in the Stoplight menu:
E.g. in the Provider API doc we have:
In the Stoplight menu, this looks like (notice some items are cut off):
Instead reuse the endpoint name in the
summaryfield:This will reduce duplication within these OpenAPI docs and with the MDS docs, and it makes it much clearer in the Stoplight menu: