aviso-server 0.11.1

Notification service for data-driven workflows with live and replay APIs.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# Spatial Filtering

Uses the shared generic schema from [Practical Examples](./overview.md).

Spatial filtering has two modes:

- `identifier.polygon`: keep notifications whose polygon intersects the request
  polygon.
- `identifier.point`: keep notifications whose polygon contains the request
  point.

This matters when many notifications share similar non-spatial identifiers and
you need geographic precision.

## Seed Notifications

These two notifications have different polygon shapes and anomaly values.

```bash
curl -sS -X POST "http://127.0.0.1:8000/api/v1/notification" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4",
      "anomaly":"42.5",
      "polygon":[[52.5,13.4],[52.6,13.5],[52.5,13.6],[52.4,13.5],[52.5,13.4]]
    },
    "payload":{"note":"poly-a"}
  }'

curl -sS -X POST "http://127.0.0.1:8000/api/v1/notification" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4",
      "anomaly":"87.2",
      "polygon":[[10.0,10.0],[10.2,10.0],[10.2,10.2],[10.0,10.2],[10.0,10.0]]
    },
    "payload":{"note":"poly-b"}
  }'
```

Expected:

- both requests return HTTP `200`

## Replay with Polygon Intersection Filter

This request polygon intersects `poly-a` but not `poly-b`.

```bash
curl -N -X POST "http://127.0.0.1:8000/api/v1/replay" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4",
      "polygon":[
        [52.52,13.45],[52.62,13.55],[52.52,13.65],
        [52.42,13.55],[52.52,13.45]
      ]
    },
    "from_id":"1"
  }'
```

Expected:

- HTTP `200`
- replay includes `poly-a`
- replay excludes `poly-b`

## Replay with Point Containment Filter

The point below is inside `poly-a` and outside `poly-b`.

```bash
curl -N -X POST "http://127.0.0.1:8000/api/v1/replay" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4",
      "point":[52.55,13.50]
    },
    "from_id":"1"
  }'
```

Expected:

- HTTP `200`
- replay includes `poly-a`
- replay excludes `poly-b`

## Replay Without Spatial Filter

No `polygon` and no `point` means no spatial narrowing.

```bash
curl -N -X POST "http://127.0.0.1:8000/api/v1/replay" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4"
    },
    "from_id":"1"
  }'
```

Expected:

- HTTP `200`
- replay may include both `poly-a` and `poly-b` because only non-spatial fields
  are applied

## Invalid: `polygon` and `point` Together

```bash
curl -sS -X POST "http://127.0.0.1:8000/api/v1/replay" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type":"extreme_event",
    "identifier":{
      "region":"north",
      "run_time":"1200",
      "severity":"4",
      "polygon":[[52.5,13.4],[52.6,13.5],[52.5,13.6],[52.4,13.5],[52.5,13.4]],
      "point":[52.55,13.50]
    },
    "from_id":"1"
  }'
```

Expected:

- HTTP `400`
- validation error says both spatial filters cannot be used together