Skip to content

Commit

Permalink
Clarify OpenAPI plugin path placeholder usage docs
Browse files Browse the repository at this point in the history
Addresses #632
  • Loading branch information
movinfinex authored and outofcoffee committed Oct 3, 2024
1 parent 2374ba0 commit fa5d877
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/openapi_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ resources:

Here, POST requests to the `/pets` endpoint will default to the HTTP 201 status code. If there is a corresponding response example for the 201 status, this will be returned in the HTTP response.

The `path` property supports placeholders, using the Vert.x Web colon format, so in the second example above, PUT requests to the endpoint `/pets/<some ID>` will return a 202 status.
The `path` property supports placeholders using the usual OpenAPI `{placeholder}` format, so in the second example above, PUT requests to the endpoint `/pets/<some ID>` will return a 202 status. Any placeholder names in paths in the plugin configuration file must match the ones used in the OpenAPI schema.

## Return a specific example

Expand Down

0 comments on commit fa5d877

Please sign in to comment.