From 5ef33a9f497ae8265e2c44e64f888df67467c205 Mon Sep 17 00:00:00 2001
From: pfych <contact@pfy.ch>
Date: Sat, 12 Oct 2024 14:23:11 +1100
Subject: [PATCH] Updated README

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index bceb0a3..e41e10c 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,34 @@ The system is **not designed** to provide any UI/UX to end users for listing and
 
 This README will be updated as the application is developed.
 
+---
+**Request:**
+```sh
+curl --request POST \
+  --url https://<API_URL>/chart/public \
+  --header 'Content-Type: application/json' \
+  --data '{ "md5": [], "sha256": [] }'
+```
+
+**Response Type:**
+```ts
+interface Chart {
+  chartId: string; // Internal to system
+  name: string;
+  md5: string;
+  sha256: string;
+  resourceUri?: string; // URI of the chart zip file
+  parentChart?: string; // Internal Id of parent chart (chartId)
+  comment?: string; // Note from maintainers
+}
+
+interface Response {
+  md5: Record<string, Chart>; // keyed by md5
+  sha256: Record<string, Chart>; // keyed by sha256
+  parents: Chart[]; // If any parent charts are required
+}
+```
+
 ---
 
 ## Local Requirements