feat: enhance GET credential endpoint with filters #297

leandro-cavalcante · 2024-11-12T12:48:14Z

Internal issuer component enhance get credential endpoint by supporting filters

Description

The purpose of this feature is to enhance the functionality of the existing GET /api/issuer/useCaseParticipation endpoint in the Issuer Component. The enhancement involves the ability to filter the returned list of use case participations by the status of the credentials (Active, Expired, or All).

Why

Instead of always returning all use case credentials it gives the customer the power of retrieving it by status.

Issue

NA

Checklist

Please delete options that are not relevant.

I have followed the contributing guidelines
I have created and linked IP issues or requested their creation by a committer
I have performed a self-review of my own code
I have successfully tested my changes locally
I have added tests that prove my changes work
I have checked that new and existing tests pass locally with my changes
I have commented my code, particularly in hard-to-understand areas
I have added copyright and license headers, footers (for .md files) or files (for images)

tests/database/SsiCredentialIssuer.DbAccess.Tests/CompanySsiDetailsRepositoryTests.cs

MaximilianHauer · 2024-12-03T07:50:27Z

business perspective sounds reasonable .

Phil91 · 2024-12-03T08:00:38Z

src/database/SsiCredentialIssuer.DbAccess/Models/StatusType.cs

@@ -0,0 +1,8 @@
+namespace Org.Eclipse.TractusX.SsiCredentialIssuer.DBAccess.Models;


Please add a licence header

Phil91 · 2024-12-03T08:01:05Z

src/issuer/SsiCredentialIssuer.Service/BusinessLogic/IIssuerBusinessLogic.cs

@@ -26,7 +26,7 @@ namespace Org.Eclipse.TractusX.SsiCredentialIssuer.Service.BusinessLogic;

 public interface IIssuerBusinessLogic
 {
-    IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync();
+    IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(string? status);


You can directly user StatusType?

Suggested change

IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(string? status);

IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(StatusType? status);

Here the StatusType was not used because the error messages we have to throw to the user. They are customized and with the use of the object it self it would not be possible.

Phil91 · 2024-12-03T08:02:16Z

src/issuer/SsiCredentialIssuer.Service/BusinessLogic/IssuerBusinessLogic.cs

+    public IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(string? status)
+    {
+        StatusType? statusTypeResult = null;
+        if (!string.IsNullOrEmpty(status))
+        {
+            if (!(Enum.TryParse<StatusType>(status, ignoreCase: true, out var statusType) || !Enum.IsDefined(typeof(StatusType), statusType)))
+            {
+                throw new ArgumentException($"Status value {status} is not valid; please use Active, Expired or All");
+            }
+            statusTypeResult = statusType;
+        }


You can directly use StatusType, than the conversion isn't needed

Suggested change

public IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(string? status)

{

StatusType? statusTypeResult = null;

if (!string.IsNullOrEmpty(status))

{

if (!(Enum.TryParse<StatusType>(status, ignoreCase: true, out var statusType) || !Enum.IsDefined(typeof(StatusType), statusType)))

{

throw new ArgumentException($"Status value {status} is not valid; please use Active, Expired or All");

}

statusTypeResult = statusType;

}

public IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(StatusType? status)

{

Here is the same. When I use the type object I cannot have a customized message. At least I could not find a way to do that. I would be grateful to have a support here

Phil91 · 2024-12-03T08:02:50Z

src/issuer/SsiCredentialIssuer.Service/Controllers/IssuerController.cs

@@ -42,16 +42,18 @@ public static RouteGroupBuilder MapIssuerApi(this RouteGroupBuilder group)
    {
        var issuer = group.MapGroup("/issuer");

-        issuer.MapGet("useCaseParticipation", (IIssuerBusinessLogic logic) => logic.GetUseCaseParticipationAsync())
+        issuer.MapGet("useCaseParticipation", (IIssuerBusinessLogic logic,
+                [FromQuery(Name = "status")] string? status) => logic.GetUseCaseParticipationAsync(status))


Can be changed to StatusType as well

Suggested change

[FromQuery(Name = "status")] string? status) => logic.GetUseCaseParticipationAsync(status))

[FromQuery(Name = "status")] StatusType? status) => logic.GetUseCaseParticipationAsync(status))

The same here, it is just to have a customized error message.

evegufy

@leandro-cavalcante helm install fails see, this could suggest that the service doesn't start successfully, could you please confirm that that's not the case?

leandro-cavalcante · 2025-02-05T15:15:59Z

@leandro-cavalcante helm install fails see, this could suggest that the service doesn't start successfully, could you please confirm that that's not the case?

I have Sync the PR and now it is working fine.

leandro-cavalcante · 2025-02-05T16:55:07Z

@evegufy This is the correct PR.

evegufy · 2025-02-05T16:56:18Z

@leandro-cavalcante there are now 17 unrelated commits show in the PR

evegufy

please remove all commits that don't belong to this change

github-advanced-security bot found potential problems Nov 12, 2024

View reviewed changes

tests/database/SsiCredentialIssuer.DbAccess.Tests/CompanySsiDetailsRepositoryTests.cs Fixed Show fixed Hide fixed

tests/database/SsiCredentialIssuer.DbAccess.Tests/CompanySsiDetailsRepositoryTests.cs Fixed Show fixed Hide fixed

MaximilianHauer requested a review from Phil91 December 3, 2024 07:50

Phil91 requested changes Dec 3, 2024

View reviewed changes

MaximilianHauer added this to the Release 25.03 milestone Dec 10, 2024

evegufy changed the title ~~feat: Internal issuer component enhance get credential endpoint by su…~~ feat: enhance GET credential endpoint with filters Feb 5, 2025

evegufy requested a review from Phil91 February 5, 2025 14:38

evegufy requested changes Feb 5, 2025

View reviewed changes

evegufy mentioned this pull request Feb 5, 2025

feat: Issuer component enhance get credential endpoint by supporting filters #279

Closed

5 tasks

evegufy requested changes Feb 6, 2025

View reviewed changes

leandro-cavalcante closed this Feb 6, 2025

leandro-cavalcante force-pushed the feature/Enhance-useCaseParticipant-GET-Credential-endpoint-by-supporting-filters branch from f98bfec to 9d3ac69 Compare February 6, 2025 14:41

leandro-cavalcante mentioned this pull request Feb 6, 2025

feat: enhance use case participant get credential endpoint by supporting filters #331

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enhance GET credential endpoint with filters #297

feat: enhance GET credential endpoint with filters #297

leandro-cavalcante commented Nov 12, 2024 •

edited by evegufy

Loading

MaximilianHauer commented Dec 3, 2024

Phil91 Dec 3, 2024

Phil91 Dec 3, 2024

leandro-cavalcante Dec 3, 2024

Phil91 Dec 3, 2024

leandro-cavalcante Dec 3, 2024

Phil91 Dec 3, 2024

leandro-cavalcante Dec 3, 2024 •

edited

Loading

evegufy left a comment

leandro-cavalcante commented Feb 5, 2025

leandro-cavalcante commented Feb 5, 2025

evegufy commented Feb 5, 2025

evegufy left a comment

		@@ -0,0 +1,8 @@
		namespace Org.Eclipse.TractusX.SsiCredentialIssuer.DBAccess.Models;

	IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(string? status);
	IAsyncEnumerable<UseCaseParticipationData> GetUseCaseParticipationAsync(StatusType? status);

	[FromQuery(Name = "status")] string? status) => logic.GetUseCaseParticipationAsync(status))
	[FromQuery(Name = "status")] StatusType? status) => logic.GetUseCaseParticipationAsync(status))

feat: enhance GET credential endpoint with filters #297

feat: enhance GET credential endpoint with filters #297

Conversation

leandro-cavalcante commented Nov 12, 2024 • edited by evegufy Loading

Description

Why

Issue

Checklist

MaximilianHauer commented Dec 3, 2024

Phil91 Dec 3, 2024

Choose a reason for hiding this comment

Phil91 Dec 3, 2024

Choose a reason for hiding this comment

leandro-cavalcante Dec 3, 2024

Choose a reason for hiding this comment

Phil91 Dec 3, 2024

Choose a reason for hiding this comment

leandro-cavalcante Dec 3, 2024

Choose a reason for hiding this comment

Phil91 Dec 3, 2024

Choose a reason for hiding this comment

leandro-cavalcante Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

evegufy left a comment

Choose a reason for hiding this comment

leandro-cavalcante commented Feb 5, 2025

leandro-cavalcante commented Feb 5, 2025

evegufy commented Feb 5, 2025

evegufy left a comment

Choose a reason for hiding this comment

leandro-cavalcante commented Nov 12, 2024 •

edited by evegufy

Loading

leandro-cavalcante Dec 3, 2024 •

edited

Loading