Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-12815

OpenAPI: Set non-optional properties as required in responses

    XMLWordPrintable

Details

    • Feature Request
    • Resolution: Unresolved
    • L3 - Default
    • None
    • None
    • None
    • None

    Description

      For nullable aware programming languages like Kotlin it's nice if the OpenAPI spec is explicit about properties that are never null so null safe code can be generated. It looks like required is already being documented for request parameters and bodies, but not for response bodies.

      An example is https://docs.camunda.org/manual/latest/reference/rest/process-definition/post-start-process-instance. I don't think "id" in the response is ever supposed to be missing. If so, it would be nice if ProcessInstanceWithVariablesDto has "id" in the required list.

      mgm-controller-panel

        This is the controller panel for Smart Panels app

        Attachments

          Issue Links

            is related to

            Bug Report - A problem which impairs or prevents the functions of the product. CAM-12326 Open API: the response schema of the "fetch and lock for external tasks" API is missing the nullable flag for some properties

            • L3 - Default - Minor issue or issue with existing workaround, feature requests and questions
            • Closed

            Activity

              People

                thorben.lindhauer Thorben Lindhauer
                daveychu Davey Chu
                Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Salesforce