Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(documentation): [#639] improve documentation #830

Merged
merged 3 commits into from
Jul 23, 2024
Merged

chore(documentation): [#639] improve documentation #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
865936f
chore(documentation): [#639] improve documentation
dsmf Jul 19, 2024
6870d01
chore(documentation): [#639] update changelog
dsmf Jul 19, 2024
a99eb75
Merge branch 'main' into chore/639-improve-documentation
dsmf Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ _**For better traceability add the corresponding GitHub issue number in each cha

## [Unreleased]

### Changed

- Improved documentation for `GET /irs/policies/paged` endpoint. #639

## [5.4.0] - 2024-07-22

### Changed
Expand Down
31 changes: 17 additions & 14 deletions docs/src/api/irs-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,19 +1042,21 @@ paths:
- Policy Store API
/irs/policies/paged:
get:
description: |
Fetch a page of policies with options to filter and sort.

- **Filtering:**
`search=<property>,[EQUALS|STARTS_WITH|BEFORE_LOCAL_DATE|AFTER_LOCAL_DATE],<value>`.
Example: `search=BPN,STARTS_WITH,BPNL12&search=policyId,STARTS_WITH,policy2`.

- **Sorting:**
`sort=<property>,[asc|desc]`.
Example: `sort=BPN,asc&sort=policyId,desc`.

- **Paging:**
Example: `page=1&size=20`
description: "Fetch a page of policies with options to filter and sort.\n \n\
Example:\n```\nsearch=BPN,STARTS_WITH,BPNL12&search=validUntil,AFTER_LOCAL_DATE,2024-12-11&sort=validUntil,asc&sort=BPN,asc\n\
```\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\
| `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\
\ \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"
operationId: getPoliciesPaged
parameters:
- description: List of business partner numbers. This may also contain the value
Expand Down Expand Up @@ -1096,7 +1098,8 @@ paths:
description: Authorization refused by server.
security:
- api_key: []
summary: Find policies.
summary: "Find registered policies that should be accepted in EDC negotiation\
\ (with filtering, sorting and paging)."
tags:
- Policy Store API
/irs/policies/{policyId}:
Expand Down
38 changes: 28 additions & 10 deletions ...src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,20 +262,38 @@ public List<String> autocomplete(

@GetMapping("/policies/paged")
@ResponseStatus(HttpStatus.OK)
@Operation(summary = "Find policies.", //
@Operation(summary = "Find registered policies that should be accepted in EDC negotiation "
+ "(with filtering, sorting and paging).", //
description = """
Fetch a page of policies with options to filter and sort.
\s
Example:
```
search=BPN,STARTS_WITH,BPNL12&search=validUntil,AFTER_LOCAL_DATE,2024-12-11&sort=validUntil,asc&sort=BPN,asc
```
\s
### Filtering
\s
`search=<Field>,[EQUALS|STARTS_WITH|BEFORE_LOCAL_DATE|AFTER_LOCAL_DATE],<Value>`.
\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` |

- **Filtering:**
`search=<property>,[EQUALS|STARTS_WITH|BEFORE_LOCAL_DATE|AFTER_LOCAL_DATE],<value>`.
Example: `search=BPN,STARTS_WITH,BPNL12&search=policyId,STARTS_WITH,policy2`.
### Sorting
`sort=[BPN|policyId|action|createdOn|validUntil],[asc|desc]`.
\s
Example: `sort=BPN,asc&sort=policyId,desc`. _(default: `BPN,asc`)_

- **Sorting:**
`sort=<property>,[asc|desc]`.
Example: `sort=BPN,asc&sort=policyId,desc`.

- **Paging:**
Example: `page=1&size=20`
### Paging
\s
Example: `page=1&size=20` _(default page size: 10, maximal page size: 1000)_
""", //
security = @SecurityRequirement(name = API_KEY), //
tags = { POLICY_API_TAG }, //
Expand Down
Loading