-
Notifications
You must be signed in to change notification settings - Fork 32
🐛♻️ Fixes public-api pagination issues and overall normalization & documentation #7747
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
pcrespov
merged 20 commits into
ITISFoundation:master
from
pcrespov:fix/public-api-solvers-pagination
May 26, 2025
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
f66a55d
🐛 Fix pagination logic in list_all_solvers_paginated to use total fro…
pcrespov deeebf9
summary of servcies and badges to OAS
pcrespov 3d538cb
test
pcrespov a746e64
fixes raised validation error because inner was handling smaller limits
pcrespov b5396c5
🐛 Fix pagination logic to use total from page_meta in multiple routes…
pcrespov d480529
🐛 Remove exclusiveMaximum constraint for limit parameter in multiple …
pcrespov 2f0ecba
🐛 Refactor pagination parameters to use optional types across multipl…
pcrespov 2ee3a8b
services/webserver api version: 0.66.0 → 0.67.0
pcrespov 7e04866
cleanup
pcrespov 65276fa
🐛 Remove DEFAULT_PAGINATION_LIMIT and use MAXIMUM_NUMBER_OF_ITEMS_PER…
pcrespov ff2a5d5
rm all defaults
pcrespov 57ff7a1
doc
pcrespov 14fbcec
🐛 Fix pagination argument names in JobService and WbApiRpcClient
pcrespov bbd6d8b
@sanderegg review: skip hidden files
pcrespov 61ba391
@sanderegg review: drop default
pcrespov 8440b1f
cleanup
pcrespov 6950e1c
@bisgaard-itis review: unset doc
pcrespov 9609abc
udpates merge
pcrespov 5a7b63d
Merge branch 'master' into fix/public-api-solvers-pagination
pcrespov 9f13c75
Merge branch 'master' into fix/public-api-solvers-pagination
pcrespov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # services | ||
| > | ||
| > Auto generated on `2025-05-26 09:50:15` using | ||
| ```cmd | ||
| cd osparc-simcore | ||
| python ./scripts/echo_services_markdown.py | ||
| ``` | ||
| | Name|Files| | | ||
| | ----------|----------|---------- | | ||
| | **AGENT**|| | | ||
| | |[services/agent/Dockerfile](./services/agent/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/agent/tags) | | ||
| | **API-SERVER**|| | | ||
| | |[services/api-server/openapi.json](./services/api-server/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/api-server/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/api-server/openapi.json) | | ||
| | |[services/api-server/Dockerfile](./services/api-server/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/api-server/tags) | | ||
| | **AUTOSCALING**|| | | ||
| | |[services/autoscaling/Dockerfile](./services/autoscaling/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/autoscaling/tags) | | ||
| | **CATALOG**|| | | ||
| | |[services/catalog/openapi.json](./services/catalog/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/catalog/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/catalog/openapi.json) | | ||
| | |[services/catalog/Dockerfile](./services/catalog/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/catalog/tags) | | ||
| | **CLUSTERS-KEEPER**|| | | ||
| | |[services/clusters-keeper/Dockerfile](./services/clusters-keeper/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/clusters-keeper/tags) | | ||
| | **DASK-SIDECAR**|| | | ||
| | |[services/dask-sidecar/Dockerfile](./services/dask-sidecar/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/dask-sidecar/tags) | | ||
| | **DATCORE-ADAPTER**|| | | ||
| | |[services/datcore-adapter/Dockerfile](./services/datcore-adapter/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/datcore-adapter/tags) | | ||
| | **DIRECTOR**|| | | ||
| | |[services/director/src/simcore_service_director/api/v0/openapi.yaml](./services/director/src/simcore_service_director/api/v0/openapi.yaml)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/director/src/simcore_service_director/api/v0/openapi.yaml) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/director/src/simcore_service_director/api/v0/openapi.yaml) | | ||
| | |[services/director/Dockerfile](./services/director/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/director/tags) | | ||
| | **DIRECTOR-V2**|| | | ||
| | |[services/director-v2/openapi.json](./services/director-v2/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/director-v2/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/director-v2/openapi.json) | | ||
| | |[services/director-v2/Dockerfile](./services/director-v2/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/director-v2/tags) | | ||
| | **DOCKER-API-PROXY**|| | | ||
| | |[services/docker-api-proxy/Dockerfile](./services/docker-api-proxy/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/docker-api-proxy/tags) | | ||
| | **DYNAMIC-SCHEDULER**|| | | ||
| | |[services/dynamic-scheduler/openapi.json](./services/dynamic-scheduler/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/dynamic-scheduler/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/dynamic-scheduler/openapi.json) | | ||
| | |[services/dynamic-scheduler/Dockerfile](./services/dynamic-scheduler/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/dynamic-scheduler/tags) | | ||
| | **DYNAMIC-SIDECAR**|| | | ||
| | |[services/dynamic-sidecar/openapi.json](./services/dynamic-sidecar/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/dynamic-sidecar/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/dynamic-sidecar/openapi.json) | | ||
| | |[services/dynamic-sidecar/Dockerfile](./services/dynamic-sidecar/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/dynamic-sidecar/tags) | | ||
| | **EFS-GUARDIAN**|| | | ||
| | |[services/efs-guardian/Dockerfile](./services/efs-guardian/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/efs-guardian/tags) | | ||
| | **INVITATIONS**|| | | ||
| | |[services/invitations/openapi.json](./services/invitations/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/invitations/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/invitations/openapi.json) | | ||
| | |[services/invitations/Dockerfile](./services/invitations/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/invitations/tags) | | ||
| | **MIGRATION**|| | | ||
| | |[services/migration/Dockerfile](./services/migration/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/migration/tags) | | ||
| | **NOTIFICATIONS**|| | | ||
| | |[services/notifications/openapi.json](./services/notifications/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/notifications/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/notifications/openapi.json) | | ||
| | |[services/notifications/Dockerfile](./services/notifications/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/notifications/tags) | | ||
| | **PAYMENTS**|| | | ||
| | |[services/payments/openapi.json](./services/payments/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/payments/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/payments/openapi.json) | | ||
| | |[services/payments/Dockerfile](./services/payments/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/payments/tags) | | ||
| | **RESOURCE-USAGE-TRACKER**|| | | ||
| | |[services/resource-usage-tracker/openapi.json](./services/resource-usage-tracker/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/resource-usage-tracker/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/resource-usage-tracker/openapi.json) | | ||
| | |[services/resource-usage-tracker/Dockerfile](./services/resource-usage-tracker/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/resource-usage-tracker/tags) | | ||
| | **STATIC-WEBSERVER**|| | | ||
| | |[services/static-webserver/client/tools/qooxdoo-kit/builder/Dockerfile](./services/static-webserver/client/tools/qooxdoo-kit/builder/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/static-webserver/tags) | | ||
| | |[services/static-webserver/client/qx_packages/ITISFoundation_qx-iconfont-material_v0_1_7/Dockerfile](./services/static-webserver/client/qx_packages/ITISFoundation_qx-iconfont-material_v0_1_7/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/static-webserver/tags) | | ||
| | |[services/static-webserver/client/qx_packages/ITISFoundation_qx-iconfont-fontawesome5_v0_2_2/Dockerfile](./services/static-webserver/client/qx_packages/ITISFoundation_qx-iconfont-fontawesome5_v0_2_2/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/static-webserver/tags) | | ||
| | |[services/static-webserver/client/qx_packages/ITISFoundation_qx-osparc-theme_v0_5_6/Dockerfile](./services/static-webserver/client/qx_packages/ITISFoundation_qx-osparc-theme_v0_5_6/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/static-webserver/tags) | | ||
| | **STORAGE**|| | | ||
| | |[services/storage/openapi.json](./services/storage/openapi.json)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/storage/openapi.json) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/storage/openapi.json) | | ||
| | |[services/storage/Dockerfile](./services/storage/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/storage/tags) | | ||
| | **WEB**|| | | ||
| | |[services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml](./services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml)|[](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml) [](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml) | | ||
| | |[services/web/Dockerfile](./services/web/Dockerfile)|[](https://hub.docker.com/r/itisfoundation/webserver/tags) | | ||
| | || | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,32 @@ | ||
| from typing import Any | ||
| from typing import Any, Final | ||
|
|
||
|
|
||
| class UnSet: | ||
| VALUE: "UnSet" | ||
| class Unset: | ||
| """Sentinel value to indicate that a parameter is not set.""" | ||
|
|
||
| VALUE: "Unset" | ||
|
|
||
| UnSet.VALUE = UnSet() | ||
|
|
||
| unuset: Final = Unset() | ||
| Unset.VALUE = Unset() | ||
|
|
||
|
|
||
| def is_unset(v: Any) -> bool: | ||
| return isinstance(v, UnSet) | ||
| return isinstance(v, Unset) | ||
|
|
||
|
|
||
| def is_set(v: Any) -> bool: | ||
| return not isinstance(v, UnSet) | ||
| return not isinstance(v, Unset) | ||
|
|
||
|
|
||
| def as_dict_exclude_unset(**params) -> dict[str, Any]: | ||
| return {k: v for k, v in params.items() if not isinstance(v, UnSet)} | ||
| """Excludes parameters that are instances of UnSet.""" | ||
| return {k: v for k, v in params.items() if not isinstance(v, Unset)} | ||
|
|
||
|
|
||
| def as_dict_exclude_none(**params) -> dict[str, Any]: | ||
| """Analogous to `as_dict_exclude_unset` but with None. | ||
|
|
||
| Sometimes None is used as a sentinel value, use this function to exclude it. | ||
| """ | ||
| return {k: v for k, v in params.items() if v is not None} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -177,9 +177,7 @@ class ServiceSummary(CatalogOutputSchema): | |
| version: ServiceVersion | ||
| name: str | ||
| description: str | ||
|
|
||
| version_display: str | None = None | ||
|
|
||
| contact: LowerCaseEmailStr | None | ||
|
|
||
| @staticmethod | ||
|
|
@@ -195,6 +193,14 @@ def _update_json_schema_extra(schema: JsonDict) -> None: | |
| "version_display": _EXAMPLE_SLEEPER["version_display"], | ||
| "contact": _EXAMPLE_SLEEPER["contact"], | ||
| }, | ||
| { | ||
| "key": _EXAMPLE_SLEEPER["key"], | ||
| "version": "100.0.0", | ||
| "name": "sleeper", | ||
| "description": "short description", | ||
| "version_display": "HUGE Release", | ||
| "contact": "[email protected]", | ||
| }, | ||
| { | ||
| "key": _EXAMPLE_FILEPICKER["key"], | ||
| "version": _EXAMPLE_FILEPICKER["version"], | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.