Updated README
This commit is contained in:
parent
0029086b3f
commit
5ef33a9f49
28
README.md
28
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
|
||||
|
Loading…
Reference in New Issue
Block a user