Skip to content

Commit

Permalink
fix(docs): oas example update with generated names (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske authored Sep 30, 2023
1 parent a2632ea commit cd3a7f2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/learnservice_oas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ x-kong-name: awesome_learnservice
# the service and upstream objects in Kong. If not given it will use the 'info.title'
# field above to name them, or a random UUID if the 'info.title' field is misssing.
# Names are converted into valid identifiers. For example,
# "Learn Services" becomes "learn-services".
# "Learn Service" becomes "Learn_Service".
# This directive can also be used on "path" and "operation" objects to name them.


Expand Down Expand Up @@ -124,12 +124,12 @@ paths:
summary: Upsert tracks
operationId: upsertTracks
# Kong routes are generated from the top-level Service name (x-kong-name or info.title
# if x-kong-name is not set), and then the operationId gets appended (with '_' as separator)
# so the generated route name here is "awesome-learnservice_upserttracks"
# if x-kong-name is not set), and then the operationId gets appended (with '-' as separator)
# so the generated route name here is "awesome-learnservice-upserttracks"
# If operationId is not specified, the default name will be the global x-kong-name
# with the path name and operation type.
# [specname]_[operationId]
# [specname]_[x-kong-name on path level]_[operation] --> if no "operationId" provided
# [specname]-[operationId]
# [specname]-[x-kong-name on path level]-[operation] --> if no "operationId" provided
# where [specname] is the x-kong-name on global level (or in its absence "info.title")
x-kong-plugin-request-termination:
# the "x-kong-plugin-<plugin name>" directive can be used to add plugins
Expand Down

0 comments on commit cd3a7f2

Please sign in to comment.