search

sphinx-contrib / openapi

OpenAPI (fka Swagger) spec renderer for Sphinx.
https://sphinxcontrib-openapi.readthedocs.io
BSD 2-Clause "Simplified" License
111 stars 81 forks source link

Array of string or integer doesn't show its description #93

Open soyangel opened 4 years ago

soyangel commented 4 years ago

Hi,

When having a property like this:

      permissions:
        description: Actuators allowed
        example:
        - a0
        - a1
        items:
          type: string
        type: array

I get an output where description is not shown:

result.acl[].permissions[] (string) –

In cases like this (or array of integers maybe) it would be nice to show the description.

soyangel commented 4 years ago

Created a pull request so a line with description will be generated for arrays of string, number, integer or boolean

94