Skip to content

Commit 6ae1b9e

Browse files
authored
Disable API routes under dev (#2130)
* Excludes files routes in API-server * Flushes banner * simplifies doc * Reverted back version until new extension is released
1 parent 24f0036 commit 6ae1b9e

File tree

7 files changed

+15
-11
lines changed

7 files changed

+15
-11
lines changed

services/api-server/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.4.0
1+
0.3.0

services/api-server/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"info": {
44
"title": "Public API Server",
55
"description": "**osparc-simcore Public RESTful API Specifications**\n## Python Library\n- Check the [documentation](https://itisfoundation.github.io/osparc-simcore-python-client)\n- Quick install: ``pip install git+https://github.com/ITISFoundation/osparc-simcore-python-client.git``\n",
6-
"version": "0.4.0",
6+
"version": "0.3.0",
77
"x-logo": {
88
"url": "https://raw.githubusercontent.com/ITISFoundation/osparc-manual/b809d93619512eb60c827b7e769c6145758378d0/_media/osparc-logo.svg",
99
"altText": "osparc-simcore logo"

services/api-server/setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.4.0
2+
current_version = 0.3.0
33
commit = True
44
message = services/api-server version: {current_version} → {new_version}
55
tag = False

services/api-server/src/simcore_service_api_server/api/root.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ def create_router(settings: AppSettings):
1111
# API
1212
router.include_router(meta.router, tags=["meta"], prefix="/meta")
1313
router.include_router(users.router, tags=["users"], prefix="/me")
14-
router.include_router(files.router, tags=["files"], prefix="/files")
1514

1615
if settings.fake_server_enabled:
16+
router.include_router(files.router, tags=["files"], prefix="/files")
17+
# TODO: still really fake
1718
router.include_router(solvers.router, tags=["solvers"], prefix="/solvers")
1819
router.include_router(jobs.router, tags=["jobs"], prefix="/jobs")
1920

services/api-server/src/simcore_service_api_server/core/application.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ def init_app(settings: Optional[AppSettings] = None) -> FastAPI:
3434
# creates app instance
3535
app = FastAPI(
3636
debug=settings.debug,
37-
title="Public API Server",
38-
description="osparc-simcore Public RESTful API Specifications",
37+
title="osparc.io web API",
38+
description="osparc-simcore public web API specifications",
3939
version=api_version,
4040
openapi_url=f"/api/{api_vtag}/openapi.json",
4141
docs_url="/dev/doc",

services/api-server/src/simcore_service_api_server/core/events.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
from fastapi import FastAPI
55

6-
from ..db.events import close_db_connection, connect_to_db
76
from .._meta import __version__, project_name
7+
from ..db.events import close_db_connection, connect_to_db
88

99
logger = logging.getLogger(__name__)
1010

@@ -26,7 +26,7 @@ async def on_startup() -> None:
2626
if app.state.settings.postgres.enabled:
2727
await connect_to_db(app)
2828

29-
print(WELCOME_MSG)
29+
print(WELCOME_MSG, flush=True)
3030

3131
return on_startup
3232

services/api-server/src/simcore_service_api_server/core/openapi.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@ def override_openapi_method(app: FastAPI):
1818
# TODO: test openapi(*) member does not change interface
1919

2020
def _custom_openapi_method(zelf: FastAPI) -> Dict:
21-
""" Overrides FastAPI.openapi member function
22-
returns OAS schema with vendor extensions
21+
"""Overrides FastAPI.openapi member function
22+
returns OAS schema with vendor extensions
2323
"""
2424
if not zelf.openapi_schema:
2525

26-
desc = compose_long_description(zelf.description)
26+
if zelf.redoc_url:
27+
desc = compose_long_description(zelf.description)
28+
else:
29+
desc = zelf.description
2730
openapi_schema = get_openapi(
2831
title=zelf.title,
2932
version=zelf.version,

0 commit comments

Comments
 (0)