Forum Discussion

gmackenzie's avatar
New Contributor
3 years ago

Boolean Parameter and conditional schemas?

Is there a way to document a boolean parameter that determines whether or not an array will be returned in the response? For example, we've got multiple parameters that operate as, "if true, [exampleField] will populate with [exampleSchema], else false, [examplefield] will display as null." Most of the get endpoints that use boolean parameters operate in this same manner so I'd like to convey that functionality via the Auto Mock if possible.

2 Replies

  • HKosova's avatar
    SmartBear Alumni (Retired)

    OpenAPI Specification does not have a way to describe request/response correlation. See this discussion for details:


    You can, however, describe these conditions in the description of those response fields and the corresponding parameters.

    • gmackenzie's avatar
      New Contributor

      That's what I've done in the meantime so looks like it'll have to do! Thanks for the help HKosova !