docs: update readme
This commit is contained in:
14
README.md
14
README.md
@@ -1,3 +1,17 @@
|
|||||||
# generic_api_endpoint
|
# generic_api_endpoint
|
||||||
|
|
||||||
Hackathon API endpoint
|
Hackathon API endpoint
|
||||||
|
|
||||||
|
## management summary // usecase
|
||||||
|
This API acts as a middelware for service portals and frontends (like SNOW), that can retrieve data via REST API. It manages metadata.
|
||||||
|
|
||||||
|
## ideas for future
|
||||||
|
- store the data in redis on initialization or on first request
|
||||||
|
- also first query redis, and not directly ONTAP
|
||||||
|
- documentation -> make it understandable, so that users will use it!
|
||||||
|
- add capability to apply filters/conditions on the return
|
||||||
|
- Alexeys
|
||||||
|
|
||||||
|
- add capability for finding best clusters, volumes
|
||||||
|
- get credentials from credential-mgmt-system
|
||||||
|
-
|
||||||
@@ -16,7 +16,7 @@ async def get_aggregates(request: Request, metric: str = "relative") -> List[Agg
|
|||||||
# You can use the metric parameter to filter or modify results as needed
|
# You can use the metric parameter to filter or modify results as needed
|
||||||
# For now, just return the same data and show metric usage
|
# For now, just return the same data and show metric usage
|
||||||
logger.debug(f"Metric used: {metric}")
|
logger.debug(f"Metric used: {metric}")
|
||||||
__aggregates = await get_data_from_ontap(request, logger, "storage/aggregates", "fields=name,uuid,space,node,home_node")
|
__aggregates = await get_data_from_ontap(request, logger, "storage/aggregates", "fields=*")
|
||||||
pprint(__aggregates)
|
pprint(__aggregates)
|
||||||
if metric == MetricEnum.relative:
|
if metric == MetricEnum.relative:
|
||||||
__aggregates = sorted(__aggregates, key=lambda r: r["space"]["block_storage"].get("used_percent"), reverse=True)
|
__aggregates = sorted(__aggregates, key=lambda r: r["space"]["block_storage"].get("used_percent"), reverse=True)
|
||||||
|
|||||||
Reference in New Issue
Block a user