From cd3a7f217d4a711c4f1b3ffa5a817e738268d2fa Mon Sep 17 00:00:00 2001 From: Thijs Schreijer Date: Sat, 30 Sep 2023 09:41:26 +0200 Subject: [PATCH] fix(docs): oas example update with generated names (#93) --- docs/learnservice_oas.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/learnservice_oas.yaml b/docs/learnservice_oas.yaml index 8063603..3f8038a 100644 --- a/docs/learnservice_oas.yaml +++ b/docs/learnservice_oas.yaml @@ -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. @@ -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-" directive can be used to add plugins