From 68eeb4b5349b24e43d76eac7c8e98c323018b223 Mon Sep 17 00:00:00 2001 From: Dominik Hanak Date: Mon, 2 Dec 2024 09:28:01 +0100 Subject: [PATCH] SRVLOGIC-478: Misleading references to src/main/resources in configuring openAPI services endpoints Fix all replacements to project_application_dir SRVLOGIC-478: Fix example of OpenAPI function definition --- modules/serverless-logic-openAPI-function-definition.adoc | 2 +- ...ess-logic-sending-rest-requests-openAPI-specification.adoc | 4 ++-- ...rverless-logic-configuring-openAPI-services-endpoints.adoc | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/serverless-logic-openAPI-function-definition.adoc b/modules/serverless-logic-openAPI-function-definition.adoc index 8572613f3db3..6cfcb6082d2e 100644 --- a/modules/serverless-logic-openAPI-function-definition.adoc +++ b/modules/serverless-logic-openAPI-function-definition.adoc @@ -14,7 +14,7 @@ "functions": [ { "name": "myFunction1", - "operation": "classpath:/myopenapi-file.yaml#myFunction1" + "operation": "specs/myopenapi-file.yaml#myFunction1" } ] } diff --git a/modules/serverless-logic-sending-rest-requests-openAPI-specification.adoc b/modules/serverless-logic-sending-rest-requests-openAPI-specification.adoc index dd859a75d18c..45a6ebda88d0 100644 --- a/modules/serverless-logic-sending-rest-requests-openAPI-specification.adoc +++ b/modules/serverless-logic-sending-rest-requests-openAPI-specification.adoc @@ -22,7 +22,7 @@ To send REST requests that are based on the OpenAPI specification files, you mus .. Identify and access the OpenAPI specification files for the services you intend to invoke. -.. Copy the OpenAPI specification files into your workflow service directory, such as `src/main/resources/specs`. +.. Copy the OpenAPI specification files into your workflow service directory, such as `/specs`. + The following example shows the OpenAPI specification for the multiplication REST service: + @@ -91,7 +91,7 @@ components: } ---- -.. Ensure that your function definitions reference the correct paths to the OpenAPI files stored in the `src/main/resources/specs` directory. +.. Ensure that your function definitions reference the correct paths to the OpenAPI files stored in the `/specs` directory. . To access the defined functions in the workflow states: diff --git a/serverless-logic/serverless-logic-managing-services/serverless-logic-configuring-openAPI-services-endpoints.adoc b/serverless-logic/serverless-logic-managing-services/serverless-logic-configuring-openAPI-services-endpoints.adoc index 6a382c35d31b..4cdce124f629 100644 --- a/serverless-logic/serverless-logic-managing-services/serverless-logic-configuring-openAPI-services-endpoints.adoc +++ b/serverless-logic/serverless-logic-managing-services/serverless-logic-configuring-openAPI-services-endpoints.adoc @@ -18,7 +18,7 @@ The `kogito.sw.operationIdStrategy` property supports the following values: `FIL quarkus.rest-client.stock_portfolio_svc_yaml.url=http://localhost:8282/ # <1> ---- + -<1> The OpenAPI File Path is `src/main/resources/openapi/stock-portfolio-svc.yaml`. The generated key that configures the URL for the REST client is `stock_portfolio_svc_yaml` +<1> The OpenAPI File Path is `/specs/stock-portfolio-svc.yaml`. The generated key that configures the URL for the REST client is `stock_portfolio_svc_yaml` `FULL_URI`:: {ServerlessLogicProductName} uses the complete URI path of the OpenAPI document as the configuration key. The full URI is sanitized to form the key. +