Uploaded image for project: 'Kogito'
  1. Kogito
  2. KOGITO-6664

[SW] Add "annotations" and "description" from the workflow definition visible in the generated OpenAPI file

    XMLWordPrintable

Details

    • 2022 Week 05-07 (from Jan 31), 2022 Week 08-10 (from Feb 21), 2022 Week 11-13 (from Mar 14)

    Description

      See: https://github.com/serverlessworkflow/specification/blob/0.8.x/specification.md#workflow-definition-structure

      Annotations and descriptions can hold useful documentation information for end-users. We should have them available on the OpenAPI documentation.

      Attachments

        Issue Links

          is blocked by

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) KOGITO-6573 Include process description to OpenAPI Swagger generated code

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Resolved

          Enhancement - An enhancement to or refactoring of existing functionality that is not configurable by an end user (typically a change made by an internal team that affects users) KOGITO-6573 Include process description to OpenAPI Swagger generated code

          • Minor - To be worked after urgent, high, and medium priorities are resolved. This term is chosen when the severity of the issue is low, or the complexity or effort to correct it may be higher, relatively speaking. For low priority issues, known workarounds exist or are not needed due to the trivial effort needed to address the issue.
          • Resolved

          Activity

            People

              hbelmiro@redhat.com Helber Belmiro
              rhn-support-zanini Ricardo Zanini Fernandes
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: