PolicyAPI - Default policy collection is shown in GET /irs/policies #734

mkanal · 2024-06-26T14:59:52Z

As Trace-X
I want default policy to be shown in GET /irs/policies
so that default policy is always visible

Hints / Details

...

Acceptance Criteria

Default policy is always listed in GET /irs/policies
Filter for default policy is supported GET /irs/policies?businessPartnerNumbers=?default
Integration Tests
Documentation in Arc42

Testing

Show default policy after adding policy for BPN
- Create default policy, add policy with BPN
- Call Endpoint GET /irs/policies without parameter
- Expected result: Default policy is listed

Out of Scope

...

mkanal · 2024-07-03T08:22:53Z

If no BPNL is used the default policy is overridden only in this case when no BPNL is given.

ds-jhartmann · 2024-07-09T12:21:09Z

Planning 2

define a process on how to create/update the default policy which allows to filter for the default policy

dsmf · 2024-07-11T10:08:40Z

If there is no custom default policy in the database the configured default needs to be returned.
If there is a custom default policy in the database the configured default must not be returned (because the configured default will most likely be more restrictive than custom policies).

…cies if no custom default policy is defined

dsmf · 2024-07-11T12:03:32Z

… policy via businessPartnerNumbers=default

…lection - add "Register a default policy" - add more parameters to "Find policies (paged)" and add some descriptions

…lection - add filter for default policies to "Get policies for BPN" - add some descriptions

…T-policies-request fix(policy-api):[#734] return configured default policies if no custo…

ds-kgassner · 2024-07-15T07:36:17Z

Successfully tested endpoints GET /irs/policies and endpoint GET /irs/policies/paged regarding:

If there is no custom default policy in the database the configured default is returned.
If there are normal policies but no default policy has been defined via the API then the configured default policy is returned.
If there is a custom default policy in the database the configured default is not returned, only the custom default policies defined via the API

Also successfully tested filtering:

GET /irs/policies?businessPartnerNumbers=default

GET /irs/policies/paged?businessPartnerNumbers=default

GET /irs/policies?search=BPN,EQUALS,default

GET /irs/policies?search=BPN,STARTS_WITH,default

mkanal · 2024-07-19T14:14:32Z

@dsmf

500 error in case of update default policy. IMHO incorrect http status code.
arc42 docu missing https://eclipse-tractusx.github.io/item-relationship-service/docs/arc42/full.html#_level_1
Deleting default policy throws 500 error code and unexpected error message. "Policy with id 'default-policy' doesn't exists! (errorRef: 6f157dd1-5980-4722-82fb-dc66fb89d017)"
What is errorRef and how to get used of it?

dsmf · 2024-07-19T15:30:36Z

@mkanal

Documentation
Default Policy Handling is no component. It has to do with configuration. Therefore I don't see what we should change in the arc42 configuration. How to configure default policies is described in
https://eclipse-tractusx.github.io/item-relationship-service/docs/administration/administration-guide.html#_helm_configuration_irs_values_yaml

and

The concept of default policies is not new and has already been included in this documentation. Only the format of the configuration value has changed, and the documentation has been updated accordingly.
If anything more is needed specify exactly where this should be documented and in what form, please.

errorRef
errorRef is a reference by which you can find error details in the logs (this way the API does not need to expose security relevant things like stack traces and still you can investigate the error by reporting the errorRef. Someone with access to the logs can then check what happened). errorRef is generated for unknown errors by the central exception handler. It is nothing new from this story.

UPDATE / DELETE HTTP 500
This story is about changing the GET endpoint. The UPDATE / DELETE endpoints are not part of this story / acceptance criteria.

However I created a pull request to handle this situation (404 if normal policy does not exist, 400 if tried to delete / update a configured default policy which are readonly):

#835

… on read-only default policies

mkanal · 2024-07-22T05:45:05Z

@dsmf Documentation in Arc42 is a AC criteria. Please document the api in the Building block view. Thx.

mkanal · 2024-07-22T10:45:06Z

LGFM PO acceptance in behalf of @jzbmw . #835 provides solution. Arc42 documentation for policy store api will be part of another story.

… on read-only default policies: tests, readability - Add missing tests for trial to register, update or delete fallback policy - Enhance code readability by relocating checks from the catch block to the beginning of relevant methods.

… on read-only default policies: add handleTrialToModifyFallbackPolicy to registerPolicy method

…donly-default-policies feat(impl): [#734] Handling for modification attempts on read-only de…

mkanal added this to IRS Jun 26, 2024

github-project-automation bot moved this to inbox in IRS Jun 26, 2024

mkanal moved this from inbox to backlog in IRS Jul 3, 2024

mkanal changed the title ~~PolicyAPI - Default policy should not be overriden once policy is added for BPNL~~ PolicyAPI - Default policy collection is shown in GET /irs/policies Jul 3, 2024

mkanal added bug Something isn't working 3 - Maintenance & Improvements (EDC & EDC API) Improvements policy_store Issues regarding the IRS policy store. labels Jul 3, 2024

mkanal moved this from backlog to next in IRS Jul 9, 2024

dsmf moved this from next to wip in IRS Jul 10, 2024

dsmf self-assigned this Jul 10, 2024

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

fix(policy-api):[eclipse-tractusx#734] return configured default poli…

8c523e7

…cies if no custom default policy is defined

dsmf mentioned this issue Jul 11, 2024

fix(policy-api):[#734] return configured default policies if no custo… #791

Merged

2 tasks

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

fix(policy-api):[eclipse-tractusx#734] update changelog

b2295d1

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

chore(policy-api): [eclipse-tractusx#734] allow to filter for default…

9820f43

… policy via businessPartnerNumbers=default

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

chore(policy-api): [eclipse-tractusx#734] update insomnia request col…

902469b

…lection - add filter for default policies to "Get policies for BPN" - add some descriptions

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

chore(policy-api): [eclipse-tractusx#734] CodeQL warnings

0f78d25

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 11, 2024

chore(policy-api): [eclipse-tractusx#734] javadoc

c48111b

ds-jhartmann added a commit that referenced this issue Jul 12, 2024

Merge pull request #791 from dsmf/fix/734-show-default-policies-in-GE…

8727ebb

…T-policies-request fix(policy-api):[#734] return configured default policies if no custo…

ds-jhartmann moved this from wip to test in IRS Jul 12, 2024

mkanal added the R24.8 label Jul 15, 2024

ds-jhartmann moved this from test to review in IRS Jul 15, 2024

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 17, 2024

chore(cleanup): [eclipse-tractusx#734] correct method naming

76d4114

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 17, 2024

chore(cleanup): [eclipse-tractusx#734] use constant

b264560

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 17, 2024

chore(cleanup): [eclipse-tractusx#734] use constant

f9b3883

dsmf mentioned this issue Jul 17, 2024

Chore/734 cleanup #825

Merged

2 tasks

mkanal moved this from review to wip in IRS Jul 19, 2024

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 19, 2024

feat(impl): [eclipse-tractusx#734] Handling for modification attempts…

66f74c4

… on read-only default policies

dsmf mentioned this issue Jul 19, 2024

feat(impl): [#734] Handling for modification attempts on read-only de… #835

Merged

2 tasks

mkanal moved this from wip to done in IRS Jul 22, 2024

mkanal closed this as completed Jul 22, 2024

mkanal added this to the 24.03 Feature Freeze milestone Jul 22, 2024

dsmf added a commit to dsmf/tx-item-relationship-service that referenced this issue Jul 23, 2024

feat(impl): [eclipse-tractusx#734] Handling for modification attempts…

b5c75da

… on read-only default policies: add handleTrialToModifyFallbackPolicy to registerPolicy method

ds-jhartmann added a commit that referenced this issue Jul 23, 2024

Merge pull request #835 from dsmf/feat/734-handle-trial-to-modify-rea…

3eeee6a

…donly-default-policies feat(impl): [#734] Handling for modification attempts on read-only de…

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PolicyAPI - Default policy collection is shown in GET /irs/policies #734

PolicyAPI - Default policy collection is shown in GET /irs/policies #734

mkanal commented Jun 26, 2024 •

edited

Loading

mkanal commented Jul 3, 2024

ds-jhartmann commented Jul 9, 2024

dsmf commented Jul 11, 2024 •

edited

Loading

dsmf commented Jul 11, 2024 •

edited

Loading

ds-kgassner commented Jul 15, 2024 •

edited

Loading

mkanal commented Jul 19, 2024 •

edited

Loading

dsmf commented Jul 19, 2024 •

edited

Loading

mkanal commented Jul 22, 2024

mkanal commented Jul 22, 2024

PolicyAPI - Default policy collection is shown in GET /irs/policies #734

PolicyAPI - Default policy collection is shown in GET /irs/policies #734

Comments

mkanal commented Jun 26, 2024 • edited Loading

Hints / Details

Acceptance Criteria

Testing

Out of Scope

mkanal commented Jul 3, 2024

ds-jhartmann commented Jul 9, 2024

Planning 2

dsmf commented Jul 11, 2024 • edited Loading

dsmf commented Jul 11, 2024 • edited Loading

PR:

ds-kgassner commented Jul 15, 2024 • edited Loading

mkanal commented Jul 19, 2024 • edited Loading

dsmf commented Jul 19, 2024 • edited Loading

mkanal commented Jul 22, 2024

mkanal commented Jul 22, 2024

mkanal commented Jun 26, 2024 •

edited

Loading

dsmf commented Jul 11, 2024 •

edited

Loading

dsmf commented Jul 11, 2024 •

edited

Loading

ds-kgassner commented Jul 15, 2024 •

edited

Loading

mkanal commented Jul 19, 2024 •

edited

Loading

dsmf commented Jul 19, 2024 •

edited

Loading