quart-schema icon indicating copy to clipboard operation
quart-schema copied to clipboard

Tasks

Open pgjones opened this issue 3 years ago • 4 comments

  • [x] Stop altering the JSONProvider (do casing directly with dicts)
  • [ ] Document how to order the openapi schema routes
  • [ ] Document how to customise the openapi schema

pgjones avatar Oct 19 '22 09:10 pgjones

Hi @pgjones, seeing that you plan to document how to customize the openapi schema, I hope I don't hijack this issue when I ask about how we could add a custom documentation/description string to each view/route?

larsblumberg avatar Aug 19 '23 12:08 larsblumberg

The view/route docstring should be added to the openapi schema - is that what you want?

pgjones avatar Aug 20 '23 12:08 pgjones

The view/route docstring should be added to the openapi schema - is that what you want?

Yes, having docstring added to the schema would be great. And now that you ask I figure that the docstring is already used for the openapi schema generation: https://github.com/pgjones/quart-schema/blob/50e8a382af554e5d227b34f427520946549eafe1/src/quart_schema/extension.py#L432

larsblumberg avatar Aug 20 '23 13:08 larsblumberg

@pgjones any updates on ordering the schema routes?

Beetroit avatar Sep 07 '24 04:09 Beetroit