ePages-de / ePages-de/restdocs-api-spec

Rich 'schema' support for query params and other fields?

Open
#197 5 comments 1 reaction 0 assignees View on GitHub
enhancement help wanted
Dominant language
Kotlin
Stars
427
Forks
116
Avg merge
23h 54m
Merged PRs (30d)
1

Description

I'm curious about how to put some important information about param/field constraints/format according to the Open API 3.0 spec: https://swagger.io/specification/#schema-object. Especially, constraints info is quite important.

Could you please point me to something if it is already supported?

Currently, I can only see the next information for the 'schema':

```
schema:
type: string
```

As far as I understand Spring REST Docs supports flexible 'attributes' approach that can be then integrated with custom templates for snippets while this is not the use case for Open API 3.0 generation. Does it worth some automated integration on your side and somehow automatically transform Bean Validation constraints into Open API Spec?

Thanks in advance.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.