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

Update OpenAPI tags #121

Merged
merged 1 commit into from
Jan 8, 2020
+20 −26
Merged

Update OpenAPI tags #121

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 15 additions & 21 deletions openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,7 @@
"/optimade/info/{entry}": {
"get": {
"tags": [
"Info",
"Structure",
"Reference"
"Info"
],
"summary": "Get Entry Info",
"operationId": "get_entry_info_optimade_info__entry__get",
Expand Down Expand Up @@ -250,7 +248,7 @@
"/optimade/references": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get References",
"operationId": "get_references_optimade_references_get",
Expand Down Expand Up @@ -410,7 +408,7 @@
"/optimade/references/{entry_id}": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get Single Reference",
"operationId": "get_single_reference_optimade_references__entry_id__get",
Expand Down Expand Up @@ -491,7 +489,7 @@
"/optimade/structures": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Structures",
"operationId": "get_structures_optimade_structures_get",
Expand Down Expand Up @@ -651,7 +649,7 @@
"/optimade/structures/{entry_id}": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Single Structure",
"operationId": "get_single_structure_optimade_structures__entry_id__get",
Expand Down Expand Up @@ -761,9 +759,7 @@
"/optimade/v0.10.0/info/{entry}": {
"get": {
"tags": [
"Info",
"Structure",
"Reference"
"Info"
],
"summary": "Get Entry Info",
"operationId": "get_entry_info_optimade_v0.10.0_info__entry__get",
Expand Down Expand Up @@ -973,7 +969,7 @@
"/optimade/v0.10.0/references": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get References",
"operationId": "get_references_optimade_v0.10.0_references_get",
Expand Down Expand Up @@ -1133,7 +1129,7 @@
"/optimade/v0.10.0/references/{entry_id}": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get Single Reference",
"operationId": "get_single_reference_optimade_v0.10.0_references__entry_id__get",
Expand Down Expand Up @@ -1214,7 +1210,7 @@
"/optimade/v0.10.0/structures": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Structures",
"operationId": "get_structures_optimade_v0.10.0_structures_get",
Expand Down Expand Up @@ -1374,7 +1370,7 @@
"/optimade/v0.10.0/structures/{entry_id}": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Single Structure",
"operationId": "get_single_structure_optimade_v0.10.0_structures__entry_id__get",
Expand Down Expand Up @@ -1484,9 +1480,7 @@
"/optimade/v0.10/info/{entry}": {
"get": {
"tags": [
"Info",
"Structure",
"Reference"
"Info"
],
"summary": "Get Entry Info",
"operationId": "get_entry_info_optimade_v0.10_info__entry__get",
Expand Down Expand Up @@ -1696,7 +1690,7 @@
"/optimade/v0.10/references": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get References",
"operationId": "get_references_optimade_v0.10_references_get",
Expand Down Expand Up @@ -1856,7 +1850,7 @@
"/optimade/v0.10/references/{entry_id}": {
"get": {
"tags": [
"Reference"
"References"
],
"summary": "Get Single Reference",
"operationId": "get_single_reference_optimade_v0.10_references__entry_id__get",
Expand Down Expand Up @@ -1937,7 +1931,7 @@
"/optimade/v0.10/structures": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Structures",
"operationId": "get_structures_optimade_v0.10_structures_get",
Expand Down Expand Up @@ -2097,7 +2091,7 @@
"/optimade/v0.10/structures/{entry_id}": {
"get": {
"tags": [
"Structure"
"Structures"
],
"summary": "Get Single Structure",
"operationId": "get_single_structure_optimade_v0.10_structures__entry_id__get",
Expand Down
2 changes: 1 addition & 1 deletion optimade/server/routers/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def get_info(request: Request):
"/info/{entry}",
response_model=Union[EntryInfoResponse, ErrorResponse],
response_model_exclude_unset=True,
tags=["Info", "Structure", "Reference"],
tags=["Info"],
)
def get_entry_info(request: Request, entry: str):
from optimade.models import EntryInfoResource
Expand Down
4 changes: 2 additions & 2 deletions optimade/server/routers/references.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"/references",
response_model=Union[ReferenceResponseMany, ErrorResponse],
response_model_exclude_unset=True,
tags=["Reference"],
tags=["References"],
)
def get_references(request: Request, params: EntryListingQueryParams = Depends()):
return get_entries(
Expand All @@ -45,7 +45,7 @@ def get_references(request: Request, params: EntryListingQueryParams = Depends()
"/references/{entry_id:path}",
response_model=Union[ReferenceResponseOne, ErrorResponse],
response_model_exclude_unset=True,
tags=["Reference"],
tags=["References"],
)
def get_single_reference(
request: Request, entry_id: str, params: SingleEntryQueryParams = Depends()
Expand Down
4 changes: 2 additions & 2 deletions optimade/server/routers/structures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"/structures",
response_model=Union[StructureResponseMany, ErrorResponse],
response_model_exclude_unset=True,
tags=["Structure"],
tags=["Structures"],
)
def get_structures(request: Request, params: EntryListingQueryParams = Depends()):
return get_entries(
Expand All @@ -44,7 +44,7 @@ def get_structures(request: Request, params: EntryListingQueryParams = Depends()
"/structures/{entry_id:path}",
response_model=Union[StructureResponseOne, ErrorResponse],
response_model_exclude_unset=True,
tags=["Structure"],
tags=["Structures"],
)
def get_single_structure(
request: Request, entry_id: str, params: SingleEntryQueryParams = Depends()
Expand Down