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.

Sign up for GitHub

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

Jump to bottom

Extend OpenAPI/spec description #151

Merged
merged 1 commit into from
Jan 30, 2020
Merged

Extend OpenAPI/spec description #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion openapi/index_openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.2",
"info": {
"title": "OPTiMaDe API - Index meta-database",
"description": "The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](http://http://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.",
"description": "The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.3.3) v0.3.3.",
"version": "0.10.1"
},
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.2",
"info": {
"title": "OPTiMaDe API",
"description": "The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](http://http://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.",
"description": "The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.3.3) v0.3.3.",
"version": "0.10.1"
},
"paths": {
Expand Down
9 changes: 5 additions & 4 deletions optimade/server/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# pylint: disable=line-too-long
import os
import json
from pathlib import Path
Expand All @@ -14,16 +15,16 @@
from .routers import info, links, references, structures
from .routers.utils import get_providers

from optimade import __api_version__
from optimade import __api_version__, __version__
import optimade.server.exception_handlers as exc_handlers


app = FastAPI(
title="OPTiMaDe API",
description=(
"The [Open Databases Integration for Materials Design (OPTiMaDe) consortium]"
"(http://http://www.optimade.org/) aims to make materials databases interoperational "
"by developing a common REST API."
f"""The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.

This specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v{__version__}) v{__version__}."""
),
version=__api_version__,
docs_url="/optimade/extensions/docs",
Expand Down
11 changes: 6 additions & 5 deletions optimade/server/main_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# pylint: disable=line-too-long
import os
import json
from pathlib import Path
Expand All @@ -12,17 +13,17 @@
from .config import CONFIG
from .routers import index_info, links

from optimade import __api_version__
from optimade import __api_version__, __version__
import optimade.server.exception_handlers as exc_handlers


app = FastAPI(
title="OPTiMaDe API - Index meta-database",
description=(
"The [Open Databases Integration for Materials Design (OPTiMaDe) consortium]"
"(http://http://www.optimade.org/) aims to make materials databases interoperational "
"by developing a common REST API.\n"
'This is the "special" index meta-database.'
f"""The [Open Databases Integration for Materials Design (OPTiMaDe) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.
This is the "special" index meta-database.

This specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v{__version__}) v{__version__}."""
),
version=__api_version__,
docs_url="/index/optimade/extensions/docs",
Expand Down