Forum Discussion

gmackenzie's avatar
gmackenzie
New Contributor
4 years ago
Solved

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, [example...
HKosova's avatar
HKosova
Icon for Alumni rankAlumni
4 years ago

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

https://github.com/OAI/OpenAPI-Specification/issues/2031

 

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

  • gmackenzie's avatar
    gmackenzie
    New Contributor
    4 years ago

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