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

Deprecate search field for taskName search in TaskDefinitionController #6009

Closed
wants to merge 1 commit into from

Conversation

cppwfs
Copy link
Contributor

@cppwfs cppwfs commented Oct 23, 2024

resolves #5993

  • Remove search as a parameter from the javadoc
  • Fix docs such that queryParameter descriptions appear in reference docs.
  • Rename Request Parameters header to Query Parameters

resolves spring-cloud#5993

* Remove search as a parameter from the javadoc
* Fix docs such that queryParameter descriptions appear in reference docs.
* Rename Request Parameters header  to Query Parameters

Signed-off-by: Glenn Renfro <[email protected]>
@cppwfs cppwfs requested review from corneil and onobc October 23, 2024 21:50
void findTaskNameContainsSubstring(String taskNameRequestParamName) throws Exception {
@Test
void findTaskNameContainsSubstring() throws Exception {
final String TASK_NAME_REQUEST_PARAMETER = "taskName";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[TinyNit] Please remove the final keyword as we only use them where it adds value (like immutable fields etc..)

@@ -411,7 +411,7 @@ void findDslTextContainsSubstring() throws Exception {

@Test
void findByDslTextAndNameBadRequest() throws Exception {
mockMvc.perform(get("/tasks/definitions").param("dslText", "fo").param("search", "f")
mockMvc.perform(get("/tasks/definitions").param("dslText", "fo").param("taskName", "f")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case we reference the param by string name rather than constant. I would be in favor of moving the TASK_NAME_REQUEST_PARAMETER to a static final constant or just using "taskName" everywhere.

Copy link
Contributor

@onobc onobc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for another deprecation removal @cppwfs 🥳
My comments are all of the nit variety.

@cppwfs
Copy link
Contributor Author

cppwfs commented Oct 24, 2024

@onobc Thank you for the review!!!

Code review comments have been applied. Rebased, Squashed, Merged.

@cppwfs cppwfs closed this Oct 24, 2024
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.

TaskDefinitionController Deprecation Cleanup
2 participants