LuboTerifaj opened a new issue, #657: URL: https://github.com/apache/incubator-kie-kogito-docs/issues/657
During https://github.com/apache/incubator-kie-kogito-docs/issues/591, there were identified several issues that might be updated. Chapter: https://sonataflow.org/serverlessworkflow/main/service-orchestration/orchestration-of-openapi-based-services.html #### Issues - There is a prerequisite "_You have installed the tooling._" - It should be specified which part of tooling is necessary to be installed in this chapter. - There is a mixed content in [OpenAPI function definition](https://sonataflow.org/serverlessworkflow/main/service-orchestration/orchestration-of-openapi-based-services.html#con-openapi-function-definition). The content could be better separated. - OpenAPI function definition in workflows - Locating and accessing OpenAPI specification files - Missing introduction of OpenAPI "request path" and "request body" - In procedure, there is : "_In the following example, the parameters are part of the request body:_" - It is not clear, what is meant by "request body" here. The workflow example follows that seems unrelated from user perspective. - In procedure, there is : "_For more information about mapping parameters in the request path instead of request body, you can refer to the following PetStore API example:_" - Same here, it is not clear what is meant by "request path" and "request body". - There is a mixed content in [Accessing functions in the workflow states](https://sonataflow.org/serverlessworkflow/main/service-orchestration/orchestration-of-openapi-based-services.html#proc-access-function-sw-states) - Accessing the functions in workflow states - Using OpenAPI specification - In addition, there is missing description in this section, how the "_Example Petstore OpenAPI specification excerpt_" is used. - Missing description, what "sanitizied" means in "_To configure the endpoints, you must use the sanitized OpenAPI specification file name_" in [Configuring the endpoint URL of OpenAPI services](https://sonataflow.org/serverlessworkflow/main/service-orchestration/orchestration-of-openapi-based-services.html#proc-configuring-openapi-service-endpoint-url) - In Procedure, there is "_The configuration key must be set as a valid environment variable._" - There is missing description how to set it. - In Procedure, there is "_For example, a file named as subtraction.yaml contains the configuration key as subtraction_yaml._" - The file in examples doesn't contain any key. The description should be changed to something like "file named as subtraction.yaml is mapped to the configuration key as subtraction_yaml." - Please ensure, enough information is provided how and where the configuration key is used, if not already provided. - In Procedure, there is "_You can use the same configuration key on each property that is related to the Quarkus REST client as shown in the following URL configuration example:_" - Missing description where the URL should be configured. - Although the description can be found in the next step, it is not a good approach and it should be rewritten. ### Acceptance criteria All issues above are resolved. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
