Updated README
Some checks failed
Build & Lint / build-lint (push) Failing after 1m9s
Deploy / setup (push) Failing after 1m3s

This commit is contained in:
pfych 2024-10-12 14:23:11 +11:00
parent 0029086b3f
commit 5ef33a9f49

View File

@ -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