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

OpenAPI: Set non-optional properties as required in responses

XMLWordPrintable

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

      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.

        This is the controller panel for Smart Panels app

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

                Created:
                Updated: