allucanget/calminer-docs
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
calminer-docs/api
History
zwitschi 07e68a553d Enhance documentation for data model and import/export processes 
- Updated data model documentation to clarify relationships between projects, scenarios, and profitability calculations.
- Introduced a new guide for data import/export templates, detailing CSV and Excel workflows for profitability, capex, and opex data.
- Created a comprehensive field inventory for data import/export, outlining input fields, derived outputs, and snapshot columns.
- Renamed "Initial Capex Planner" to "Capex Planner" and "Processing Opex Planner" to "Opex Planner" for consistency across user guides.
- Adjusted access paths and related resources in user guides to reflect the new naming conventions.
- Improved clarity and consistency in descriptions and instructions throughout the user documentation.
2025-11-13 14:10:47 +01:00
..
README.md
Enhance documentation for data model and import/export processes
2025-11-13 14:10:47 +01:00

README.md

API Documentation

Project & Scenario Endpoints

Method Path Roles Success Common Errors Notes
GET /projects viewer, analyst, project_manager, admin 200 + ProjectRead[] 401 unauthenticated, 403 insufficient role Lists all projects visible to the caller.
POST /projects project_manager, admin 201 + ProjectRead 401, 403, 409 name conflict, 422 validation Creates a project and seeds default pricing settings.
GET /projects/{project_id} viewer, analyst, project_manager, admin 200 + ProjectRead 401, 403, 404 missing project Returns a single project by id.
PUT /projects/{project_id} project_manager, admin 200 + ProjectRead 401, 403, 404, 422 Updates mutable fields (name, location, operation_type, description).
DELETE /projects/{project_id} project_manager, admin 204 401, 403, 404 Removes the project and cascading scenarios.
GET /projects/{project_id}/scenarios viewer, analyst, project_manager, admin 200 + ScenarioRead[] 401, 403, 404 Lists scenarios that belong to the project.
POST /projects/{project_id}/scenarios project_manager, admin 201 + ScenarioRead 401, 403, 404 missing project, 409 duplicate name, 422 validation Creates a scenario under the project. Currency defaults to pricing metadata when omitted.
POST /projects/{project_id}/scenarios/compare viewer, analyst, project_manager, admin 200 + ScenarioComparisonResponse 401, 403, 404, 422 mismatch/validation Validates a list of scenario ids before comparison.
GET /scenarios/{scenario_id} viewer, analyst, project_manager, admin 200 + ScenarioRead 401, 403, 404 Retrieves a single scenario.
PUT /scenarios/{scenario_id} project_manager, admin 200 + ScenarioRead 401, 403, 404, 422 Updates scenario metadata (status, dates, currency, resource).
DELETE /scenarios/{scenario_id} project_manager, admin 204 401, 403, 404 Removes the scenario and dependent data.

OpenAPI Reference

  • Interactive docs: GET /docs
  • Raw schema (JSON): GET /openapi.json