Add sort arugment for the search API

[gaborbernat]

Fixes #4740

[oracle-contributor-agreement]

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

• PR author: [email protected] (@gaborbernat)
• [email protected] (@gaborbernat)

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

[vladak]

The Apirary documentation in the apiary.apib file needs update for the /search endpoint.

[vladak]

Also, needs a test case.

[vladak]

Just a note: this conflicts with the changes done for Lucene 9.x update in PR #4867. It looks like this can be reconciled easily, though.

[gaborbernat]

I signed the OCA on Friday any idea when it will be approved?

[oracle-contributor-agreement]

Thank you for signing the OCA.

[gaborbernat]

@vladak when you can please take another look, thanks!

[vladak]

@vladak when you can please take another look, thanks!

The failing tests need to be fixed first.

[gaborbernat]

@vladak can you take another look please? Thanks!

[vladak]

In general this looks good; I will go through the test code in a little bit more detail before approving, though.

In the meantime you might want to add copyrights to the changed files.

[gaborbernat]

In the meantime you might want to add copyrights to the changed files.

Thanks for making the changes, will revisit them soon.

@vladak Not sure I understand what you mean here, but addressed the other feedback.

Take a look at the copyright section in source files with external contributors, for example the file having the biggest count of copyright notices

opengrok/opengrok-indexer/src/main/java/org/opengrok/indexer/web/Util.java

Lines 20 to 27 in fe5560e

	/*
	* Copyright (c) 2005, 2025, Oracle and/or its affiliates. All rights reserved.
	* Portions Copyright (c) 2011, Jens Elkner.
	* Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
	* Portions Copyright (c) 2019, Krystof Tulinger <[email protected]>.
	* Portions Copyright (c) 2023, Ric Harris <[email protected]>.
	* Portions Copyright (c) 2024, Gino Augustine <[email protected]>.
	*/

While it is not required to add copyright notice I believe, it is a good practice to add it when making non-trivial changes to files (mostly for attribution, I think).

[gaborbernat]

@vladak any update this?

[vladak]

@vladak any update this?

Still need to revisit the changes. In addition to that PR #4867 will create a conflict in SearchEngine.java - need to see what is that best order to merge these, i.e. who will go in first.

Have you made your mind w.r.t. the copyrights yet ?

[vladak]

Looks good. Needs rebase and merge with the Lucene 9 upgrade changes.

[gaborbernat]

Have you made your mind w.r.t. the copyrights yet ?

Not sure what I need to do here 🤔 I'm fine with whatever.

[vladak]

Have you made your mind w.r.t. the copyrights yet ?

Not sure what I need to do here 🤔 I'm fine with whatever.

I'd say add a copyright entry to each file with a non-trivial change.

[gaborbernat]

I'd say add a copyright entry to each file with a non-trivial change.

Do I need to? How would this entry look like?

[vladak]

I'd say add a copyright entry to each file with a non-trivial change.

Do I need to? How would this entry look like?

I think it is not necessary. Such entry would look like this:

/*
 * ...
 * Portions Copyright (c) 2025, Your Name <[email protected]>.
 */

where the ... stand out for any pre-existing copyright entry. The e-mail is optional. Again, take a look at the example above.