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

Add new annotations to support embedded parameters, ranged values, and source type for conversion from @OperationParams. #6659

Open
wants to merge 8 commits into
base: rel_8_0
Choose a base branch
from

Conversation

lukedegruchy
Copy link
Collaborator

@lukedegruchy lukedegruchy commented Jan 28, 2025

  • Non-functional purely API semantics change.
  • Add EmbeddableOperationParams as a type-level annotation to mark a class as an embedded parameters class that will be passed to an Operations Provider API in place of individual IdParam and OperationParam annotated method parameters
  • Add EmbeddedOperationPrams as a method parameter annotation to indicate that an Operation Provider method parameter will include a type that is annotated as above with EmbeddableOperationParams
  • Add new Header annotation to capture single or multiple header values for a given header name.

To illustrate:

public class SomeProvider {
   @Operation("doStuff")
   public void doStuff(@EmbeddedOperationParams MyParamsClass theParams) {}
}

@EmbeddableParams
public class MyParamsClass {
    private final String myId;

    public MyParamsClass(
      @Header("Timezone")
      String theTimezone,
       @OperationParam
       String theId
    ) {
       ...
    }
}

…d source type for conversion from @OperationParams.
Copy link

github-actions bot commented Jan 28, 2025

Formatting check succeeded!

Copy link

codecov bot commented Jan 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (rel_8_0@fc8ce73). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff             @@
##             rel_8_0    #6659   +/-   ##
==========================================
  Coverage           ?   83.50%           
  Complexity         ?    28566           
==========================================
  Files              ?     1797           
  Lines              ?   111176           
  Branches           ?    13965           
==========================================
  Hits               ?    92835           
  Misses             ?    12353           
  Partials           ?     5988           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant