Uploaded image for project: 'jBPM'
  1. jBPM
  2. JBPM-6810

Include example models of payloads in Swagger documentation

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Major
    • None
    • 7.6.0.Final
    • KieServer, Remote Services
    • None
    • NEW
    • Low
    • NEW

    Description

      Swagger has been introduced in JBPM-4480 and it really helps communicate with KIE Server REST services. However, the last missing bit is a model of a body/payload which has to be sent in the particular POST/PUT request. This is currently missing in the documentation so users have to either know how the body looks like or find it in the documentation/on the Internet. Currently, when you open an endpoint there is only this body snippet:

      <?xml version="1.0" encoding="UTF-8"?>
      <!-- XML example cannot be generated -->
      

      So I think it should be possible to add examples.

      I will assign Duncan to this, but feel free to reassign as you wish.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              mmacik@redhat.com Marian Macik
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: