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

Fix config doc annotations for OpenAPI builder #4419

Merged
merged 10 commits into from
Jun 29, 2022
Merged

Fix config doc annotations for OpenAPI builder #4419

merged 10 commits into from
Jun 29, 2022

Conversation

tjquinno
Copy link
Member

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 at META-INF/openapi. and any of yml, yaml, or json 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.

@tjquinno tjquinno added this to the 3.0.0 milestone Jun 21, 2022
@tjquinno tjquinno self-assigned this Jun 21, 2022
@tjquinno tjquinno marked this pull request as draft June 22, 2022 20:11
@tjquinno
Copy link
Member Author

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.

@tjquinno
Copy link
Member Author

NOTE: I made a small local change to the config doc generator tool to get the proper output in the docs/shared/config/io.helidon.openapi.SEOpenAPISupport.adoc file in the latest push. I am in touch with David and Tomas to see if I was doing something wrong with the annotations or if there is, in fact, a change needed in the tool.

@tjquinno
Copy link
Member Author

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 type. The latest push fixes that, and when I ran the tool locally, the merging seems to be happening as expected.

@tjquinno tjquinno marked this pull request as ready for review June 24, 2022 18:51
@tjquinno tjquinno merged commit 7fefb4e into helidon-io:master Jun 29, 2022
@tjquinno tjquinno deleted the openapi-config-2.x branch June 29, 2022 20:35
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

Successfully merging this pull request may close these issues.

2 participants