-
Notifications
You must be signed in to change notification settings - Fork 566
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
Fix config doc annotations for OpenAPI builder #4419
Conversation
After I created this PR, I discovered that @dalexandrov has also been working on some of the same files but had not created a PR yet (although he has subsequently: #4421). He and I will be reconciling our changes. I have marked this as a draft until he and I figure that out. |
NOTE: I made a small local change to the config doc generator tool to get the proper output in the |
…tions; make config method public so the metadata processor will process it
In a semi-private chat, Tomas pointed out that in the merging config options I was incorrectly specifying the impl builder instead of the interface as |
Part of #4209 (and part of #4314)
Reviewers: Please pay particular attention to the default value for the
static-file
config setting as proposed. Our code looks for a static OpenAPI document file atMETA-INF/openapi.
and any ofyml
,yaml
, orjson
for the file type.I've expressed the default value for config doc purposes as
META-INF/openapi.{json,yaml,yml}
to try to capture this succinctly, although obviously that's not a value that a user would be able to copy and paste into an actual config file and have it work.I think that's OK. In fact, expressing this in some other way would be more verbose and no more clear, I think.