Skip to content

Conversation

@SzymanskiBartlomiej
Copy link
Contributor

@SzymanskiBartlomiej SzymanskiBartlomiej commented Dec 21, 2024

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 /results endpoint to include details about the new page_number and page_numbers query parameters, which allow for paginated retrieval of results.
  • docs/backend/openapi.yaml: Added page_number and page_numbers as optional query parameters in the /results endpoint to support paginated results.
  • docs/backend/openapi.yaml: Introduced new response objects to include pagination information in the /results endpoint.

Enhancements to estimator metadata retrieval:

  • docs/backend/openapi.yaml: Updated the summary and response description for the /estimators endpoint to reflect the retrieval of estimator metadata instead of just names.
  • docs/backend/openapi.yaml: Added detailed properties for the estimators_metadata response, including page metadata.

Schema updates:

Additional changes:

  • docs/backend/persistency.md: Updated the class diagram to include new fields file_name, page_name, and page_dimension in the PageModel class.

@SzymanskiBartlomiej SzymanskiBartlomiej self-assigned this Dec 21, 2024
@SzymanskiBartlomiej SzymanskiBartlomiej linked an issue Dec 21, 2024 that may be closed by this pull request
@grzanka grzanka merged commit 05cff73 into main Dec 21, 2024
1 check passed
@grzanka grzanka deleted the 23-update-model-documentation branch December 21, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update model documentation

3 participants