Skip to content

Commit

Permalink
Merged in coar-notify-7_CST-13257 (pull request DSpace#56)
Browse files Browse the repository at this point in the history
[CST-13257] added lowerIp and upperIpd

Approved-by: Stefano Maffei
  • Loading branch information
eskander17 authored and steph-ieffam committed Jan 17, 2024
2 parents 9082831 + 22ecdaf commit 9238863
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion ldnservices.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ Return codes:
"ldnUrl" : "https://service-name.org/ldn-inbox",
"enabled" : true,
"score" : "0.375",
"lowerIp" : "192.168.0.1",
"upperIp" : "192.168.0.5",
"notifyServiceInboundPatterns" :
[
{
Expand Down Expand Up @@ -65,6 +67,8 @@ Status codes:
* ldnUrl: the URL of the LDN Inbox
* enabled: This proeprty is a simple boolean, it defines if the service is selected as one of the active ones
* score: This property defines to the safety score assigned by the user
* lowerIp: This property defines to the lowerIp of the ip range
* upperIp: This property defines to upperIp of the ip range
* inboundPatterns: an array that contains inbound pattern defined by 3 properties:
* pattern: the defining pattern name for the pattern itself
* constraint: a filter put in place during the pattern creation
Expand All @@ -89,6 +93,8 @@ Only administrator users can create LDN notify service. The content-type is JSON
"ldnUrl": "https://service-name.org/ldn-inbox",
"score" : "0.765",
"enabled" : true,
"lowerIp" : "192.168.0.1",
"upperIp" : "192.168.0.5",
"notifyServiceInboundPatterns":
[
{"pattern":"patternA","constraint":"itemFilterA","automatic":true},
Expand Down Expand Up @@ -324,6 +330,29 @@ to update enabled of ldn notify service
]
```

to update the lowerIp of ldn notify service

```json
[
{
"op": "replace",
"path": "/lowerIp",
"value": "192.168.0.1"
}
]
```
to update the upperIp of ldn notify service

```json
[
{
"op": "replace",
"path": "/upperIp",
"value": "192.168.0.5"
}
]
```

to replace all inboundPatterns of ldn notify service,
if value contains an empty array all inboundPatterns will be removed

Expand Down Expand Up @@ -436,7 +465,7 @@ to replace constraint of specific outboundPattern of ldn notify service

### Remove

to remove name or ldnUrl from ldn notify service
to remove name or ldnUrl or lowerIp or upperIp from ldn notify service

```json
[
Expand All @@ -456,6 +485,24 @@ to remove name or ldnUrl from ldn notify service
]
```

```json
[
{
"op": "remove",
"path": "/lowerIp"
}
]
```

```json
[
{
"op": "remove",
"path": "/upperIp"
}
]
```

status codes:
* 401 Unauthorized - if you are not authenticated
* 403 Forbidden - if you are not logged in with sufficient permissions. Only administrators
Expand Down Expand Up @@ -597,6 +644,8 @@ A sample search would be `/server/api/ldn/ldnservices/search/byLdnUrl?ldnUrl=ser
"ldnUrl" : "https://service-one.org/ldn-inbox",
"score" : "0.57",
"enabled" : true,
"lowerIp" : "192.168.0.1",
"upperIp" : "192.168.0.5",
"notifyServiceInboundPatterns" :
[
{
Expand Down Expand Up @@ -643,6 +692,8 @@ A sample search would be `/server/api/ldn/ldnservices/search/byInboundPattern?pa
"ldnUrl" : "https://service.ldn.org/inbox",
"score" : "0.675",
"enabled" : false,
"lowerIp" : "192.168.0.1",
"upperIp" : "192.168.0.5",
"notifyServiceInboundPatterns" : [ {
"pattern" : "request-review",
"constraint" : "itemFilterA",
Expand All @@ -663,6 +714,8 @@ A sample search would be `/server/api/ldn/ldnservices/search/byInboundPattern?pa
"ldnUrl" : "https://service-two.org/ldn-inbox",
"score" : "0.34",
"enabled" : true,
"lowerIp" : "192.168.0.1",
"upperIp" : "192.168.0.5",
"notifyServiceInboundPatterns" : [ {
"pattern" : "request-review",
"constraint" : "itemFilterA",
Expand Down

0 comments on commit 9238863

Please sign in to comment.