This commit is contained in:
24
README.md
24
README.md
@ -12,10 +12,17 @@ There are situations where you need data to slap into a template, and the data m
|
||||
over time.
|
||||
|
||||
* Sending alert e-mails including contact information for the curent support techs.
|
||||
* Seasonal greetings in automatically generated content.
|
||||
* Seasonal greetings or out-of-office notices in automatically generated content.
|
||||
|
||||
ParamDB solves this problem by serving collections of keys over HTTP. A collection can
|
||||
contain any number of keys, and a key can contain any number of values.
|
||||
contain any number of keys, and a key can contain any number of values. As the values
|
||||
are serialized, ParamDB could be used to serve arrays or JSON objects representing
|
||||
work schedules, service configuration, or any other clever use you can think of.
|
||||
|
||||
> [!CAUTION]
|
||||
> You can put a lot of data into a collection, both structured and ustructured. But you
|
||||
> don't want to put too much as every key of the collection is matched and returned when
|
||||
> the collection is queried.
|
||||
|
||||
## Features
|
||||
|
||||
@ -59,19 +66,18 @@ Content-Type: application/json
|
||||
|
||||
[
|
||||
{
|
||||
"openhours": {
|
||||
"value": "Mo-Fr 09-17, Sa-Su 12-02",
|
||||
"valid": {
|
||||
"from": "2024-10-01 00:00:00 +02:00",
|
||||
"until": "2024-10-07 23:59:59 +02:00"
|
||||
}
|
||||
"key": "openhours",
|
||||
"value": "Mo-Fr 09-17, Sa-Su 12-02",
|
||||
"valid": {
|
||||
"from": "2024-10-01 00:00:00 +02:00",
|
||||
"until": "2024-10-07 23:59:59 +02:00"
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The only required key is `value`. As there can only be one value without validity it will overwrite, any request without validity will overwrite any existing value without validity.
|
||||
> The only required keys are `key` and `value`. As there can only be one value without validity it will overwrite, any request without validity will overwrite any existing value without a specified validity.
|
||||
|
||||
### Retrieve current values
|
||||
|
||||
|
Reference in New Issue
Block a user