@golemio/chmu 1.0.6 → 1.0.8-dev.1561229432
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
Binary file
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
asyncapi: 3.0.0
|
|
2
|
+
info:
|
|
3
|
+
title: CHMU
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
description: Downloads CHMU hourly aggregated data from FTP to csv files.
|
|
6
|
+
channels:
|
|
7
|
+
chmu.downloadMeasurementsTask:
|
|
8
|
+
address: dataplatform.chmu.downloadMeasurementsTask
|
|
9
|
+
description: Downloads CHMU hourly aggregated data from FTP to csv files.
|
|
10
|
+
bindings:
|
|
11
|
+
amqp:
|
|
12
|
+
is: queue
|
|
13
|
+
queue:
|
|
14
|
+
durable: true
|
|
15
|
+
messages:
|
|
16
|
+
chmu.DownloadMeasurementsMessage:
|
|
17
|
+
$ref: "#/components/messages/chmu.DownloadMeasurementsMessage"
|
|
18
|
+
operations:
|
|
19
|
+
chmu.downloadMeasurementsTask:
|
|
20
|
+
action: "send"
|
|
21
|
+
channel:
|
|
22
|
+
$ref: "#/channels/chmu.downloadMeasurementsTask"
|
|
23
|
+
components:
|
|
24
|
+
messages:
|
|
25
|
+
chmu.DownloadMeasurementsMessage:
|
|
26
|
+
payload:
|
|
27
|
+
type: object
|
|
28
|
+
properties:
|
|
29
|
+
"from":
|
|
30
|
+
type: string
|
|
31
|
+
nullable: true
|
|
32
|
+
"to":
|
|
33
|
+
type: string
|
|
34
|
+
nullable: true
|
|
35
|
+
additionalProperties: false
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Implementační dokumentace modulu *Chmu*
|
|
2
|
+
|
|
3
|
+
## Záměr
|
|
4
|
+
|
|
5
|
+
Modul slouží ke stažení chmu dat z ftp agregovaných po hodině do csv souborů.
|
|
6
|
+
|
|
7
|
+
## Vstupní data
|
|
8
|
+
|
|
9
|
+
### Data aktivně stahujeme
|
|
10
|
+
|
|
11
|
+
Popis dat, jak je pomocí cronu a integration-engine stahujeme. Pokud jsou data stahována z více zdrojů, každý zdroj je popsán zvlášť.
|
|
12
|
+
|
|
13
|
+
#### *ChmuDatasource*
|
|
14
|
+
|
|
15
|
+
- zdroj dat
|
|
16
|
+
- golemio ftp
|
|
17
|
+
- formát dat
|
|
18
|
+
- csv soubor
|
|
19
|
+
- [validační schéma: ](https://gitlab.com/operator-ict/golemio/code/modules/chmu/-/blob/development/src/schema-definitions/datasources/ChmuSchemaProvider.ts)
|
|
20
|
+
- [příklad vstupních dat](https://gitlab.com/operator-ict/golemio/code/modules/chmu/-/blob/development/test/data/6443_2023020215.txt)
|
|
21
|
+
- frekvence stahování
|
|
22
|
+
- jednou za hodinu
|
|
23
|
+
- název rabbitmq fronty
|
|
24
|
+
- `chmu.downloadMeasurementsTask`
|
|
25
|
+
|
|
26
|
+
## Zpracování dat / transformace
|
|
27
|
+
|
|
28
|
+
Popis transformace a případného obohacení dat. Zaměřeno hlavně na workery a jejich metody.
|
|
29
|
+
|
|
30
|
+
### *ChmuWorker*
|
|
31
|
+
|
|
32
|
+
Stručný popis workeru.
|
|
33
|
+
|
|
34
|
+
#### *DownloadMeasurementsTask*
|
|
35
|
+
|
|
36
|
+
- vstupní rabbitmq fronta
|
|
37
|
+
- název `chmu.downloadMeasurementsTask`
|
|
38
|
+
- parametry `from` and `to` volitelné parametry v iso formátu
|
|
39
|
+
- datové zdroje
|
|
40
|
+
- `ChmuDatasource`
|
|
41
|
+
- transformace
|
|
42
|
+
- odkaz na transformaci dat, případně stručný popis tranformace
|
|
43
|
+
- [transformace dat](https://gitlab.com/operator-ict/golemio/code/modules/chmu/-/blob/development/src/integration-engine/transformations/MeasurementsTransformation.ts)
|
|
44
|
+
- data modely
|
|
45
|
+
- [MeasurementModel](https://gitlab.com/operator-ict/golemio/code/modules/chmu/-/blob/development/src/schema-definitions/definitions/models/MeasurementModel.ts)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## Uložení dat
|
|
50
|
+
|
|
51
|
+
Popis ukládání dat.
|
|
52
|
+
|
|
53
|
+
### Obecné
|
|
54
|
+
|
|
55
|
+
- typ databáze
|
|
56
|
+
- PSQL
|
|
57
|
+
- datábázové schéma
|
|
58
|
+
- schéma: `chmu`
|
|
59
|
+
|
|
60
|
+
- retence dat
|
|
61
|
+
- data jsou zachována
|
|
62
|
+
- AsyncApi dokumentace
|
|
63
|
+
- [AsyncApi](./asyncapi.yaml)
|
package/docs/index.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Udržování changelogu v projektech
|
|
2
|
+
|
|
3
|
+
_Tohle je výstup z [general#345](https://gitlab.com/operator-ict/golemio/code/general/-/issues/345)_
|
|
4
|
+
|
|
5
|
+
Začínáme zavádět changelogy podle [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) a semantického verzování
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
## [version] - release date
|
|
9
|
+
|
|
10
|
+
### type of action
|
|
11
|
+
|
|
12
|
+
- Description (([project#issue](link to the issue)))
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
- Během vývoje a code reviews je potřeba kontrolovat existenci CHANGELOG.md a zda byl přidán záznam do Unreleased sekce pod správný typ změny
|
|
16
|
+
- Added
|
|
17
|
+
- Changed
|
|
18
|
+
- Deprecated
|
|
19
|
+
- Removed
|
|
20
|
+
- Fixed
|
|
21
|
+
- Security
|
|
22
|
+
- Rovněž je potřeba ujistit, že aktuální kopie [keeping_a_changelog.md](/introduction/keeping_a_changelog.md) se nachází ve složce _docs/_, pokud tam už není
|
|
23
|
+
- Před releasem nahradit Unreleased za _[version] - release date_
|
|
24
|
+
- Po release bumpnout verzi a přidat novou Unreleased sekci (v případě částečného release přesunout nenasazené změny do Unreleased)
|
|
25
|
+
|
|
26
|
+
**Příklad changelogu pro pid modul**
|
|
27
|
+
```markdown
|
|
28
|
+
# Changelog
|
|
29
|
+
|
|
30
|
+
All notable changes to this project will be documented in this file.
|
|
31
|
+
|
|
32
|
+
## [Unreleased]
|
|
33
|
+
|
|
34
|
+
### Added
|
|
35
|
+
|
|
36
|
+
- Modularized migrations ([pid#53](https://gitlab.com/operator-ict/golemio/code/modules/pid/-/issues/53))
|
|
37
|
+
|
|
38
|
+
## [2.0.12] - 2021-10-18
|
|
39
|
+
|
|
40
|
+
### Fixed
|
|
41
|
+
|
|
42
|
+
- Empty array of tripsIds in updateDelay
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Příklad projektů se zavedeným changelogem**
|
|
46
|
+
|
|
47
|
+
- [Golemio CLI](https://gitlab.com/operator-ict/golemio/code/golemio-cli/-/blob/development/CHANGELOG.md)
|
|
48
|
+
- [PID Module](https://gitlab.com/operator-ict/golemio/code/modules/pid/-/blob/development/CHANGELOG.md)
|