Uploaded image for project: 'Serverless logic'
  1. Serverless logic
  2. SRVLOGIC-467

[DOCS] Configuring OpenAPI services should comply to kn workflow plugin use case

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • 1.35.0
    • 1.34.0, 1.35.0
    • Documentation
    • None
    • False
    • None
    • False

      Summary


      In Configuring OpenApi servic guide, there is a step that says: Copy the OpenAPI specification files into your workflow service directory, such as src/main/resources/specs.
      However, nowhere prior to this is explained that users should create such folder.
      Furthermore, kn workflow plugin suggest users to create only /specs folder in the root directory of a workflow.
      This is connfusing and the guide should be working in accordance to kn workflow plugin use case.

      Environment


      N/A

      Steps to reproduce


      1. Follow creating and managing wfs guide
      2. Try to follow configuring OpenApi service to modify the workflow to use openApi calls in functions.

      Actual results


      Confusing reference of `src/main/resources/specs` that suggest Java and is not following what `kn workflow deploy --help` suggests.

      Expected results


      Reference of `<root_dir>/specs` as a target location for openApi specifications. Follow what `kn workflow deploy --help` suggests.

      Testing


      Validate the documentation and ensure there is clear way to do this use case.

              kaldesai Kalyani Desai
              dhanak@redhat.com Dominik Hanak
              Dominik Hanak Dominik Hanak
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: