API documentation: property description, patterns etc

🗣 General Discussion
1

Hi,

I am writing an OpenApi 3.0 Schema and in there I have a few components/schemas and within some of those, I have properties with description and patterns.

Those descriptions and patterns do not show up in the generated documentation. Am I missing something?

Example schema:

      properties:
        fin:
          type: string
          description: "Lorem Ipsum"
          pattern: "/^[A-HJ-NPR-Z0-9]{17}$/"

The generated documentation then just consists of a raw request body and a Curl example.

EDIT: I see a similar thing in Swagger. GET parameters can have elaborate descriptions etc, but POST request bodies are limited to the raw JSON object. I wonder what’s the reasoning behind this. Being able to document that a certain request body parameter will have to validate against a specific regex would reduce questions and support, I assume.