feat(impl): [eclipse-tractusx#639] update documentation concerning IS…

…O date support
dsmf · Jul 23, 2024 · 84934fa · 84934fa
1 parent 87953c1
commit 84934fa
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 16 deletions.
diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml
@@ -1047,13 +1047,14 @@ paths:
         ```\n \n### Filtering\n \n`search=<Field>,[EQUALS|STARTS_WITH|BEFORE_LOCAL_DATE|AFTER_LOCAL_DATE],<Value>`.\n\
         \ \nExample: `search=BPN,STARTS_WITH,BPNL12&search=policyId,STARTS_WITH,policy2`.\n\
         \ \n| Field        | Supported Operations                     | Value Format\
-        \         |\n|--------------|------------------------------------------|----------------------|\n\
+        \                       |\n|--------------|------------------------------------------|------------------------------------|\n\
         | `BPN`        | `EQUALS`, `STARTS_WITH`                  | any string   \
-        \        |\n| `policyId`   | `EQUALS`, `STARTS_WITH`                  | any\
-        \ string           |\n| `action`     | `EQUALS`                          \
-        \       | `use` or `access`    |\n| `createdOn`  | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`\
-        \  | `yyyy-MM-dd`         |\n| `validUntil` | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`\
-        \  | `yyyy-MM-dd`         |\n\n### Sorting\n`sort=[BPN|policyId|action|createdOn|validUntil],[asc|desc]`.\n\
+        \                      |\n| `policyId`   | `EQUALS`, `STARTS_WITH`       \
+        \           | any string                         |\n| `action`     | `EQUALS`\
+        \                                 | `use` or `access`                  |\n\
+        | `createdOn`  | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`  | `yyyy-MM-dd` or\
+        \ ISO date with time |\n| `validUntil` | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`\
+        \  | `yyyy-MM-dd` or ISO date with time |\n\n### Sorting\n`sort=[BPN|policyId|action|createdOn|validUntil],[asc|desc]`.\n\
         \ \nExample: `sort=BPN,asc&sort=policyId,desc`. _(default: `BPN,asc`)_\n\n\
         ### Paging\n \nExample: `page=1&size=20` _(default page size: 10, maximal\
         \ page size: 1000)_\n"

diff --git a/...src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/...src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java
@@ -196,7 +196,8 @@ public Map<String, List<PolicyResponse>> getPolicies(//
             @RequestParam(required = false) //
             @ValidListOfBusinessPartnerNumbers(allowDefault = true) //
             @Parameter(description = "List of business partner numbers. "
-                    + "This may also contain the value \"default\" in order to query the default policies.") //
+                                     + "This may also contain the value \"default\" in order to query the default policies.")
+            //
             final List<String> businessPartnerNumbers //
     ) {
 
@@ -263,7 +264,7 @@ public List<String> autocomplete(
     @GetMapping("/policies/paged")
     @ResponseStatus(HttpStatus.OK)
     @Operation(summary = "Find registered policies that should be accepted in EDC negotiation "
-            + "(with filtering, sorting and paging).", //
+                         + "(with filtering, sorting and paging).", //
                description = """
                        Fetch a page of policies with options to filter and sort.
                        \s
@@ -278,13 +279,13 @@ public List<String> autocomplete(
                        \s
                        Example: `search=BPN,STARTS_WITH,BPNL12&search=policyId,STARTS_WITH,policy2`.
                        \s
-                       | Field        | Supported Operations                     | Value Format         |
-                       |--------------|------------------------------------------|----------------------|
-                       | `BPN`        | `EQUALS`, `STARTS_WITH`                  | any string           |
-                       | `policyId`   | `EQUALS`, `STARTS_WITH`                  | any string           |
-                       | `action`     | `EQUALS`                                 | `use` or `access`    |
-                       | `createdOn`  | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`  | `yyyy-MM-dd`         |
-                       | `validUntil` | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`  | `yyyy-MM-dd`         |
+                       | Field        | Supported Operations                     | Value Format                       |
+                       |--------------|------------------------------------------|------------------------------------|
+                       | `BPN`        | `EQUALS`, `STARTS_WITH`                  | any string                         |
+                       | `policyId`   | `EQUALS`, `STARTS_WITH`                  | any string                         |
+                       | `action`     | `EQUALS`                                 | `use` or `access`                  |
+                       | `createdOn`  | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`  | `yyyy-MM-dd` or ISO date with time |
+                       | `validUntil` | `BEFORE_LOCAL_DATE`, `AFTER_LOCAL_DATE`  | `yyyy-MM-dd` or ISO date with time |
                        
                        ### Sorting
                        `sort=[BPN|policyId|action|createdOn|validUntil],[asc|desc]`.
@@ -326,7 +327,8 @@ public Page<PolicyResponse> getPoliciesPaged(//
             @RequestParam(required = false) //
             @ValidListOfBusinessPartnerNumbers(allowDefault = true) //
             @Parameter(name = "businessPartnerNumbers", description = "List of business partner numbers. "
-                    + "This may also contain the value \"default\" in order to query the default policies.") //
+                                                                      + "This may also contain the value \"default\" in order to query the default policies.")
+            //
             final List<String> businessPartnerNumbers) {
 
         if (pageable.getPageSize() > MAX_PAGE_SIZE) {