Skip to content
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

Fix/issues #41 Swagger ui with mult examples #376

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions boaviztapi/routers/openapi_doc/examples.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
def convert_to_openapi_example(configuration_examples):
return{k: {"summary": "{example} payload".format(example=k),"value":v} for k, v in configuration_examples.items()}



server_configuration_examples = {
"emptyserver": {},
"DellR740": {"model":
{
"type": "rack"
Expand Down Expand Up @@ -35,6 +41,8 @@
}
}}

server_configuration_examples_openapi = convert_to_openapi_example(server_configuration_examples)

components_examples = {
"cpu": {
"name": "intel xeon gold 6134",
Expand Down
5 changes: 3 additions & 2 deletions boaviztapi/routers/server_router.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
from boaviztapi.model.device.server import DeviceServer
from boaviztapi.routers.openapi_doc.descriptions import server_impact_by_model_description, \
server_impact_by_config_description, all_archetype_servers, get_archetype_config_desc
from boaviztapi.routers.openapi_doc.examples import server_configuration_examples
from boaviztapi.routers.openapi_doc.examples import server_configuration_examples,server_configuration_examples_openapi
from boaviztapi.service.archetype import get_server_archetype, get_device_archetype_lst
from boaviztapi.service.verbose import verbose_device
from boaviztapi.service.impacts_computation import compute_impacts
Expand Down Expand Up @@ -60,7 +60,8 @@ async def server_impact_from_model(archetype: str = config["default_server"],
@server_router.post('/',
description=server_impact_by_config_description)
async def server_impact_from_configuration(
server: Server = Body(None, example=server_configuration_examples["DellR740"]),
server: Server = Body(None,examples=server_configuration_examples,
openapi_examples=server_configuration_examples_openapi),
verbose: bool = True,
duration: Optional[float] = config["default_duration"],
archetype: str = config["default_server"],
Expand Down