[WIP] Add support for custom media types #101
Closed
Conversation
This file contains hidden or 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
pk-work
reviewed
Jun 5, 2025
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java
Outdated
Show resolved
Hide resolved
| * @return The registry. | ||
| */ | ||
| @GenIgnore | ||
| MediaTypeRegistry mediaTypes(); |
Contributor
There was a problem hiding this comment.
Suggested change
| MediaTypeRegistry mediaTypes(); | |
| MediaTypeRegistry getMediaTypeRegistry(); |
Contributor
Author
There was a problem hiding this comment.
In hindsight I think that this field does not have to exposed here at all.
Comment on lines
17
to
40
| static DefaultMediaTypeRegistry createDefault() { | ||
| return new DefaultMediaTypeRegistry() | ||
| .register(MediaTypeRegistration.TEXT_PLAIN) | ||
| .register(MediaTypeRegistration.MULTIPART_FORM_DATA) | ||
| .register(MediaTypeRegistration.APPLICATION_JSON) | ||
| .register(MediaTypeRegistration.APPLICATION_OCTET_STREAM); | ||
| } | ||
|
|
||
| /** | ||
| * Creates an empty registry. | ||
| * | ||
| * @return An empty registry. | ||
| */ | ||
| static DefaultMediaTypeRegistry createEmpty() { | ||
| return new DefaultMediaTypeRegistry(); | ||
| } | ||
|
|
||
| /** | ||
| * Registers a new MediaTypeHandler | ||
| * | ||
| * @param registration The mediatype registration. | ||
| * @return This registry for a fluent interface. | ||
| */ | ||
| DefaultMediaTypeRegistry register(MediaTypeRegistration registration); |
Contributor
There was a problem hiding this comment.
Keep this in DefaultMediaTypeRegistry
| * @param context Whether the analyser is for a request or response. | ||
| * @return A fresh content analyser instance. | ||
| */ | ||
| ContentAnalyser createContentAnalyser(String contentType, Buffer content, ValidationContext context); |
lukasjelonek
added a commit
to lukasjelonek/vertx-openapi
that referenced
this pull request
Jun 12, 2025
lukasjelonek
added a commit
to lukasjelonek/vertx-openapi
that referenced
this pull request
Jun 12, 2025
Contributor
Author
|
I extracted the builder-part from this PR and requested a new PR: #103 |
lukasjelonek
added a commit
to lukasjelonek/vertx-openapi
that referenced
this pull request
Jun 30, 2025
lukasjelonek
force-pushed
the
main
branch
2 times, most recently
from
4e21944 to
b63d3fe
Compare
Contributor
|
Will be resolved with #118 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation:
At the moment it is not possible to use media types that are not included in the static supported mediatypes list in requests and responses. This forces the users to use generic media types where more specific ones exist in their openapi specs.
This pull-request replaces the current static list of mediatypes with a registry that allows the registration of additional mediatypes.
At the moment this is an early draft of the feature and the pull request is used to provide a place for a first review.
Conformance:
The Eclipse Contributor Agreement is signed by me.
The code style will be enforced once this feature reaches a mature state.