Improve OpenAPI definition #392
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I am one of the developers of the [Micronaut Framework](https://micronaut.io/). As part of writing a guide for our [OpenAPI support](https://github.com/micronaut-projects/micronaut-openapi/), I was contemplating using Open Meteo as an example service. I was happy to find it was coming with an OpenAPI spec. However, the response types are not precise enough for our generated code. Typically, return types are often `Object` instead of something strongly typed. This commit fixes this by introducing component types with the appropriate return types. I'm not an OpenAPI expert but I have verified that this fixes the issue I was seeing.
|
Awesome, thanks! This is a great addition and I will add more weather variables in another commit. Just a couple of weeks ago the Swift server group announced more tools for OpenAPI Swift integration. This will help to automate integration and make sure the schema definition is always up to date |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am one of the developers of the Micronaut Framework. As part of writing a guide for our OpenAPI support, I was contemplating using Open Meteo as an example service.
I was happy to find it was coming with an OpenAPI spec. However, the response types are not precise enough for our generated code. Typically, return types are often
Objectinstead of something strongly typed.This commit fixes this by introducing component types with the appropriate return types. I'm not an OpenAPI expert but I have verified that this fixes the issue I was seeing.