Skip to content

Commit fa5d877

Browse files
Mov Infinexoutofcoffee
authored andcommitted
Clarify OpenAPI plugin path placeholder usage docs
Addresses #632
1 parent 2374ba0 commit fa5d877

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/openapi_plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ resources:
232232

233233
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.
234234

235-
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.
235+
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.
236236

237237
## Return a specific example
238238

0 commit comments

Comments
 (0)