Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe ignored fields in additionalProperties #6

Closed
codeasashu opened this issue Nov 3, 2019 · 1 comment
Closed

Describe ignored fields in additionalProperties #6

codeasashu opened this issue Nov 3, 2019 · 1 comment

Comments

@codeasashu
Copy link
Collaborator

Currently, the documented behaviour for ignored file is to just skip it in generated swagger schema.

However, for exactly this purpose, additionalProperties field has been added in OAS 3.0

additionalProperties will document the field as optional, which allows one to add example of optional field which may come handly for mockers and documentation.

Please add this feature

@codeasashu
Copy link
Collaborator Author

If we are to ignore dynamic keys, this is currently not possible with OAS 3

However, if we want to ignore the values of a key, we can do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant