Skip to content

Commit

Permalink
Add comments detailing use of 'x-eov-operation-id' and 'operationId' …
Browse files Browse the repository at this point in the history
…in example 3-eov-operations. (#322)

Co-authored-by: Thomas Carmichael <tcarmichael@pros.com>
  • Loading branch information
Thomas Carmichael and Thomas Carmichael committed Jul 7, 2020
1 parent a3137a4 commit 04c06d3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions examples/3-eov-operations/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ paths:
get:
description: |
ping then pong!
# use operationId, (x-eov-operation-id is optional. it can be used in place of operationId or to override it)
# operationId is used in /ping path (x-eov-operation-id is optional). x-eov-operation-id can be used in place of operationId. If both x-eov-operation-id and operationId are present, x-eov-operation-id will override operationId.
operationId: ping
x-eov-operation-handler: routes/ping
responses:
Expand All @@ -35,7 +35,7 @@ paths:
get:
description: |
Returns all pets
operationId: findPets
# x-eov-operation-id is specified as well as operationId. This allows for backwards compatibility with code generator tools that rely on operationId in the OpenAPI spec.
x-eov-operation-id: pets#list
x-eov-operation-handler: routes/pets
parameters:
Expand Down

0 comments on commit 04c06d3

Please sign in to comment.