[POLICY_STORE] Multi-Filter support for API endpoint GET /irs/policies

[mkanal]

As api endpoint consumer
I want filter for multiple columns at one time
so that I am able to filter policies based on my specific request

Links

• relates to [POLICY][BE] Add multi filter, cascading sorting, pagination to policy view traceability-foss#969

Hints / Details

• API endpoint GET /irs/policies supports no filter support attribute

Acceptance Criteria

• Enable multiple filter support on all attributes with AND combination
  • Datatype: String supports Operator equals
  • Datatype: Date supports Operator (Date Range, Date from, Date to)
• Add autocompletion for district values [startsWith A%] (limited by 100 entries)
• Convert GET to POST endpoint POST /policies/paged

 "searchCriteria": {
        "filter": [
            "channel,EQUAL,SENDER,AND"
        ]
    }

Out of Scope

• Multi filter support on column "Constraints"
• Enable multiple filter support on all attributes with OR combination - results with NotSupported Exception

[mkanal]

@dsmf Please clarify

• Is OR combination really needed and currently supported by Trace-X.
• Date and String filtering
• Autocompletion for Sting values

[dsmf]

Not needed:

• Filtering using OR operator is not needed according to @ds-mwesener.

Already implemented in #639:

• Sorting by the date fields createdOn and validUntil asc, desc.
• Filtering by multiple fields.

The following needs to be implemented in the current story:

• Filtering by the date fields createdOn and validUntil
• This should be implemented as follows (according to @mkanal):

search=<dateFieldName>,AFTER_LOCAL_DATE,<YYYY-MM-DD>&search=<dateFieldName>,BEFORE_LOCAL_DATE,<YYYY-MM-DD>

• A Separate autocomplete endpoint that only returns distinct results for the requested field with a limit (no paging).

The following stories are also needed:

• Extend policy store api by name attribute #756

PBIs should be created for the following required functionalities:

• Convert the paging endpoint into POST (because the URL gets too long soon if multiple search criteria are applied):
  Policy Store API: Convert /policies/paged into POST #802
• Implement a GET /policies/{policyId} endpoint for getting the policy detail by policyId (The paging endpoint works differently here as it returns the same policy multiple times - one for each associated BPN):
  Policy Store API: Get policy by ID #803

[dsmf]

Outcome

Date filter createdOn and validUntil

• Added possibility to filter by createdOn and validUntil to Policy Store API: GET /irs/policies/paged:
• Added some unit tests for filtering and sorting by date, see PolicyPagingServiceTest.FilterByDateTests and SortByDateTests
• Insomnia parameters were already prepared in [POLICY_STORE] Add filter, sorting, pagination for GET endpoints #639, see https://github.com/eclipse-tractusx/item-relationship-service/blob/main/local/testing/request-collection/IRS_Request_Collection.json "Find policies (paged)"

PR: #798

Autocomplete Endpoint

• Added autocomplete endpoint Policy Store API: GET /irs/policies/attributes/{attribute}.
• Added request to the insomnia IRS_Request_Collection, see "Policy attribute auto-complete"
• OpenAPI documentation incl. adjustements in irs-api.yaml

PR: #799

PBIs

• Policy Store API: Convert /policies/paged into POST #802
• Policy Store API: Get policy by ID #803

[ds-kgassner]

Successfully tested:

• Added possibility to filter by createdOn and validUntil to Policy Store API: GET /irs/policies/paged:
• Added autocomplete endpoint Policy Store API: GET /irs/policies/attributes/{attribute}.
• Added request to the insomnia IRS_Request_Collection, see "Policy attribute auto-complete"

[mkanal]

Merge is outstanding.

[mkanal]

AC -> Convert GET to POST endpoint POST /policies/paged will be transferred to
#802
#803
LGFM PO acceptance in behalf of @jzbmw