Repository navigation
NGWPC-11732 - Update API Docs - #109
Conversation
|
As I'm moving onto the Confluence docs, I can/will come back to this to update based on feedback - I have been divorced from the API side of Icefabric for a while, so cleaning up the docs was a denser task than anticipated. Hopefully getting eyes on the current changes will highlight where more changes should be made, or more fixes, etc. |
quercoak
left a comment
quercoak
left a comment
There was a problem hiding this comment.
I haven't had time to run the dashboard live yet, but please fix based on comments. You deleted a lot of content in the move from readme to deployment. The streamlit and local running is still relevant information worth keeping around, just not at the top of the file. I pushed a small commit with some things I wanted to add so make to pull.
| ./compose.sh api test | ||
| # Prod (OE) deploy | ||
| ./compose.sh api prod | ||
| ``` |
There was a problem hiding this comment.
You removed everything about the dashboard. Please add back info about running the dashboard locally and docker.
| ``` | ||
| Note: Functionality is split into `optional-dependencies` in `pyproject.toml`. If you only require base functionality, install as `uv sync`. If you require some extras (e.g. `icechunk`, `io`), you can specify `uv sync --extra icechunk --extra io` as needed. For local develpoment, `--all-extras` is recommended for complete functionality. | ||
|
|
||
| ### Running/deploying the services |
There was a problem hiding this comment.
Please leave this heading pointing the user at deployment.md for full details. Keep here:
- running the API locally (glue or sql)
- full local deployment from archive
And move the rest to deployment.md alerting users to find additional details there
|
|
||
| ### Overview | ||
|
|
||
| Script located at `tools/local_catalog_sync.py` - downloads the Icefabric catalog from S3 and rewrites paths for local use |
There was a problem hiding this comment.
You need aws environment variables set
|
|
||
| ### Overview | ||
|
|
||
| Script located at `tools/localize_streamflow.py` - downloads the Icechunk store from S3 to the local filesystem |
| @@ -18,27 +18,6 @@ source .venv/bin/activate | |||
| ``` | |||
| Note: Functionality is split into `optional-dependencies` in `pyproject.toml`. If you only require base functionality, install as `uv sync`. If you require some extras (e.g. `icechunk`, `io`), you can specify `uv sync --extra icechunk --extra io` as needed. For local develpoment, `--all-extras` is recommended for complete functionality. | |||
|
|
|||
There was a problem hiding this comment.
Add a header here called Deployment and direct the user to the URI of the page
| "flowpaths": Flowpaths, | ||
| "nexus": Nexus, | ||
| "reference_flowpaths": ReferenceFlowpaths, | ||
| "waterbodies": Waterbodies, |
| ReservoirDA, | ||
| VirtualFlowpaths, | ||
| VirtualNexus, | ||
| Waterbodies, |
| python -m app.main --catalog glue --deploy-env test | ||
| # Prod | ||
| python -m app.main --catalog glue --deploy-env prod | ||
| ``` |
|
Just updated to resolve Quercus' comments - linked to the full API deploy docs where possible, as well as with the Dashboard deploy full doc |
Updating API docs to bring information in-line with current tools/schemas
Additions
Removals
export_catalog.pyChanges