From 395b94a44c6f00ccb1ea7acb8673387a75e66996 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mat=C4=9Bj=20=C5=BDucha?=
 <145539518+Matej-Zucha-TUL@users.noreply.github.com>
Date: Fri, 14 Mar 2025 10:46:07 +0000
Subject: [PATCH] Doc/rest -> Main (#6)

Add example exchange JSONs and a brief README about them
---
 docs/json_examples/1-burza->zpravy.json | 27 +++++++++++++++++++++++++
 docs/json_examples/2-zpravy->burza.json | 22 ++++++++++++++++++++
 docs/json_examples/3-burza->zpravy.json | 22 ++++++++++++++++++++
 docs/json_examples/README.md            |  6 ++++++
 4 files changed, 77 insertions(+)
 create mode 100644 docs/json_examples/1-burza->zpravy.json
 create mode 100644 docs/json_examples/2-zpravy->burza.json
 create mode 100644 docs/json_examples/3-burza->zpravy.json
 create mode 100644 docs/json_examples/README.md

diff --git a/docs/json_examples/1-burza->zpravy.json b/docs/json_examples/1-burza->zpravy.json
new file mode 100644
index 0000000..f9a2654
--- /dev/null
+++ b/docs/json_examples/1-burza->zpravy.json
@@ -0,0 +1,27 @@
+{
+  "timestamp": "2012-04-23T18:25:43.511Z",
+  "date_from": "2012-04-23T18:25:43.511Z",
+  "date_to": "2012-04-23T18:25:43.511Z",
+  "stocks": [
+    {
+      "name": "MSFT",
+      "rating": null,
+      "sell": null
+    },
+    {
+      "name": "HPQ",
+      "rating": null,
+      "sell": null
+    },
+    {
+      "name": "TXN",
+      "rating": null,
+      "sell": null
+    },
+    {
+      "name": "IDK",
+      "rating": null,
+      "sell": null
+    }
+  ]
+}
diff --git a/docs/json_examples/2-zpravy->burza.json b/docs/json_examples/2-zpravy->burza.json
new file mode 100644
index 0000000..fd03b46
--- /dev/null
+++ b/docs/json_examples/2-zpravy->burza.json
@@ -0,0 +1,22 @@
+{
+  "timestamp": "2012-04-23T18:25:43.511Z",
+  "date_from": "2012-04-23T18:25:43.511Z",
+  "date_to": "2012-04-23T18:25:43.511Z",
+  "stocks": [
+    {
+      "name": "MSFT",
+      "rating": -10,
+      "sell": null
+    },
+    {
+      "name": "HPQ",
+      "rating": 2,
+      "sell": null
+    },
+    {
+      "name": "TXN",
+      "rating": 8,
+      "sell": null
+    }
+  ]
+}
diff --git a/docs/json_examples/3-burza->zpravy.json b/docs/json_examples/3-burza->zpravy.json
new file mode 100644
index 0000000..10af2aa
--- /dev/null
+++ b/docs/json_examples/3-burza->zpravy.json
@@ -0,0 +1,22 @@
+{
+  "timestamp": "2012-04-23T18:25:43.511Z",
+  "date_from": "2012-04-23T18:25:43.511Z",
+  "date_to": "2012-04-23T18:25:43.511Z",
+  "stocks": [
+    {
+      "name": "MSFT",
+      "rating": null,
+      "sell": true
+    },
+    {
+      "name": "HPQ",
+      "rating": null,
+      "sell": true
+    },
+    {
+      "name": "TXN",
+      "rating": null,
+      "sell": false
+    }
+  ]
+}
diff --git a/docs/json_examples/README.md b/docs/json_examples/README.md
new file mode 100644
index 0000000..2e0ebe9
--- /dev/null
+++ b/docs/json_examples/README.md
@@ -0,0 +1,6 @@
+# Ukázky JSON souborů, které si budou předávat moduly Zprávy a Burza
+
+Jednotlivé JSON soubory jsou očíslované podle schématu v root README souboru, tj.:
+- První výměna putuje od Burzy do Zpráv, jedná se o seznam akcií v určeném časovém období, pro které chce modul burza získat ohodnocení v podobě raitingu, akcie byly vybrány filtrem v modulu Burzy
+- Druhá výměna putuje od Zpráv do Burzy, jedná se o seznam akcií a jejich ratingu, tento seznam byl profiltrován v modulu Zprávy
+- Tření výměna putuje od Burzy do Zpráv, jedná se o seznam akcií s doporučením prodat/držet/koupit/nekupovat