Update documentation #24
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes significant updates to the OpenAPI documentation for the backend, specifically focusing on enhancing the simulation results and estimator metadata retrieval endpoints. The changes include adding new query parameters for pagination, updating response descriptions, and introducing new schemas for better structuring the data.
Enhancements to simulation results retrieval:
docs/backend/openapi.yaml: Updated the description for the/resultsendpoint to include details about the newpage_numberandpage_numbersquery parameters, which allow for paginated retrieval of results.docs/backend/openapi.yaml: Addedpage_numberandpage_numbersas optional query parameters in the/resultsendpoint to support paginated results.docs/backend/openapi.yaml: Introduced new response objects to include pagination information in the/resultsendpoint.Enhancements to estimator metadata retrieval:
docs/backend/openapi.yaml: Updated the summary and response description for the/estimatorsendpoint to reflect the retrieval of estimator metadata instead of just names.docs/backend/openapi.yaml: Added detailed properties for theestimators_metadataresponse, including page metadata.Schema updates:
docs/backend/openapi.yaml: Added a newPageschema to represent page objects in the API responses.docs/backend/openapi.yaml: Updated theEstimatorschema to reference the newPageschema for better data structuring.Additional changes:
docs/backend/persistency.md: Updated the class diagram to include new fieldsfile_name,page_name, andpage_dimensionin thePageModelclass.