docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Support for deepObjects in query parameters

Open tyler-mairose-sp opened this issue 2 years ago • 2 comments

Documentation link

N/A

Describe the problem

Request for improvement.

We are looking for support for the deepObject notation. Given the following example specification:

name: query
in: query
description: |
  Allows for pagination and sorting.
required: false
schema:
  type: object
  properties:
    limit:
      type: integer
      description: The limit of results to return
      example: 100
    offset:
      type: integer
      description: The number of records to offset
      example: 50
    order:
      type: string
      description: The attribute to order by
      example: created_at
style: deepObject
explode: true

Today the plugin loads in the query parameter, but does not describe anything about the properties of the schema (limit, offset, order).

Suggested fix

We would like to see described in the UI the ability to use the deepObject notation as follows:

/users?query[limit]=100&query[offset]=2

We would also like to see the description and example for each property under the query parameter query

tyler-mairose-sp avatar May 23 '23 15:05 tyler-mairose-sp

:tada: Thanks for opening your first issue here! Welcome to the community!

related to #750

sserrata avatar Jun 28 '24 20:06 sserrata