aviso-server 0.12.0

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

# Practical Examples

This section provides copy-paste examples for common workflows.

All examples use the same generic event schema so behavior is easy to compare.

## Shared Generic Schema

```yaml
notification_schema:
  extreme_event:
    topic:
      base: extreme_event
      key_order: [region, run_time, severity, anomaly]
    identifier:
      region:
        description: "Geographic region label."
        type: EnumHandler
        values: ["north", "south", "east", "west"]
        required: true
      run_time:
        type: TimeHandler
        required: true
      severity:
        description: "Severity level from 1 to 7."
        type: IntHandler
        range: [1, 7]
        required: true
      anomaly:
        type: FloatHandler
        range: [0.0, 100.0]
        required: false
      polygon:
        type: PolygonHandler
        required: false
    payload:
      required: false
```

## Shared Assumptions

- Base URL: `http://127.0.0.1:8000`
- Content type: `application/json`
- Replay examples use `from_id` or `from_date` explicitly.

## Identifier Value Style

The examples in this section send scalar identifier values as JSON strings,
including numeric ones (`"severity":"4"`, `"anomaly":"42.5"`). The server
canonicalizes scalar values to strings. JSON numbers are accepted and produce
the same result. Constraint arguments (`{"gte":5}`, `{"between":[3,7]}`) use
JSON numbers because they are typed comparison operands.

## Notify Identifier Rule

`POST /api/v1/notification` requires every identifier key declared in the
schema, whether it has `required: true` or `required: false`. Every value must
pass its handler validation.

The flag matters on **watch** and **replay**. A missing key marked
`required: true` returns `400`. A missing key marked `required: false` becomes a
wildcard. Provided values and constraint objects still pass through handler
validation.

The shared schema above declares five keys, so notify examples on the following
pages include all five.

Next:

- [Basic Notify/Watch/Replay](./basic-notify-watch-replay.md)
- [Spatial Filtering](./spatial-filtering.md)
- [Constraint Filtering](./constraint-filtering.md)
- [Replay Starting Points](./replay-starting-points.md)
- [Admin Operations](./admin-operations.md)