Object Query Parameters incorrect

Get Support
1

Hello, I’m evaluating Apidog for generating some pretty complex API documentation. When generating off my schema, I noticed at least one major error. I have the following query parameter:

name: filter
      in: query
      style: deepObject
      required: false
      description: |
        ## Filter Field
        The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
      schema:
        type: object
        properties:
          creator:
            type: string
            description: |
              `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID`
          identifier:
            type: string
            description: |
              `filter[identifier]=value` List only those containers matching this identifier. May return multiple results.
          search:
            type: string
            description: |
              `filter[search]=value` search containers for a value associated with a field on the given container(s).
          state:
            type: string
            description: |
              `filter[state]=value1,value2` state filtering will allow you to filter by the container's

etc.

However, when looking at the Apidog docs, I see all the filter parameters ‘flattened’ and no filter parameter shows up, just its sub-types, which is incorrect (see image). Is it possible to resolve this?

Thanks!

image.png
image.png2292×1916 559 KB

2

Evans

3

When importing Swagger/OpenAPI files, Apidog will flatten the objects in the query parameters.

We will optimize this feature. If imported as object as is, we need to consider how to input the value of the parameter when sending the request.

4

yeah, at the very least the documentation should accurately reflect it as an object.

5

thanks