feat(core) add @SegmentParameter annotation #30
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
Services like refind use the {segment} path parameter
often don't document them. This makes for a broken
openapi specs that fails validation of some code
generation tools.
This commit adds a `@SegmentParameter` annotation to
make it easier for restler-core dependants to fix
their broken openapi specs.
nawarian
requested review from
Hillkorn,
kasimakis,
niallkelly and
rg-sebastian-k
Hillkorn
approved these changes
Apr 22, 2025
rg-sebastian-k
approved these changes
Apr 22, 2025
Contributor
rg-sebastian-k
left a comment
rg-sebastian-k
left a comment
There was a problem hiding this comment.
Hey @nawarian - thanks for the contribution. Regarding how to test: You can always make a snapshot and update a service to use the snapshot. Then you can inspect the created OpenAPI specs etc.pp.
Keep in mind to update https://github.com/researchgate/restler/blob/master/doc/release-notes.md before releasing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This pull request
@SegmentParameterannotation, a meta-annotation that adopts default params for a restler segment paramBaseServiceResourceadopt the@SegmentParamterannotationThe problem I'm trying to address
Services like refind use the
{segment}path parameter often don't document them. This makes for a broken openapi specs that fails validation of some code generation tools.This commit adds a
@SegmentParameterannotation to make it easier for restler-core dependants to fixtheir broken openapi specs.
Next steps
This is less about the
restler-coreand more about our services. Upon approval of this merge request, I'll send out patches to another project (I'm mostly interested in refind atm) in order to help them fix this issue :)Where I need your help
I don't really know how to test this, and hopefully I don't need to know 😇 Please have a look and let me know if you spot any problems with this.