Skip to content

Commit

Permalink
try insert metadata tags
Browse files Browse the repository at this point in the history
  • Loading branch information
KoalaGeo committed Apr 24, 2023
1 parent 211a4d6 commit 6a9ef5d
Showing 1 changed file with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions app/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,33 +77,6 @@ def setup_logging(logging_level=logging.INFO):
async def landing_page(request: Request):
return templates.TemplateResponse('landing_page.html', {'request': request})

def custom_openapi():
if app.openapi_schema:
return app.openapi_schema
openapi_schema = get_openapi(
title="pyagsapi - AGS File Utilities Tools and API",
version="4.5.0",
description=("The API performs schema validation, data validation and conversion of your AGS files. It also exports a graphical log from AGS data held by NGDC"
"Schema validation and conversion uses https://gitlab.com/ags-data-format-wg/ags-python-library"),
terms_of_service="https://www.bgs.ac.uk/legal-and-policy/terms-of-use/",
contact={
"name": "BGS Enquiries",
"url": "https://www.bgs.ac.uk/about-bgs/contact-us/",
"email": "[email protected]",
},
license_info={
"name": "Open Government Licence v3",
"url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
},
routes=app.routes,
)
openapi_schema["info"]["x-logo"] = {
"url": ("https://raw.githubusercontent.com/BritishGeologicalSurvey/pyagsapi"
"/main/app/static/img/BGS-Logo-Pos-RGB-01.png")
}
app.openapi_schema = openapi_schema
return app.openapi_schema

tags_metadata = [
{
"name": "validate",
Expand All @@ -125,12 +98,40 @@ def custom_openapi():
"name": "ags_log",
"description": "Generate a graphical log (.pdf) from AGS data held by the National Geoscience Data Centre.",
"externalDocs": {
"description": "NGDC AGS Data",
"description": "NGDC AGS Borehole Index",
"url": "https://ogcapi.bgs.ac.uk/collections/agsboreholeindex",
},
},
]

def custom_openapi():
if app.openapi_schema:
return app.openapi_schema
openapi_schema = get_openapi(
title="pyagsapi - AGS File Utilities Tools and API",
version="4.5.0",
description=("The API performs schema validation, data validation and conversion of your AGS files. It also exports a graphical log from AGS data held by NGDC"
"Schema validation and conversion uses https://gitlab.com/ags-data-format-wg/ags-python-library"),
terms_of_service="https://www.bgs.ac.uk/legal-and-policy/terms-of-use/",
contact={
"name": "BGS Enquiries",
"url": "https://www.bgs.ac.uk/about-bgs/contact-us/",
"email": "[email protected]",
},
license_info={
"name": "Open Government Licence v3",
"url": "https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
},
openapi_tags=tags_metadata,
routes=app.routes,
)
openapi_schema["info"]["x-logo"] = {
"url": ("https://raw.githubusercontent.com/BritishGeologicalSurvey/pyagsapi"
"/main/app/static/img/BGS-Logo-Pos-RGB-01.png")
}
app.openapi_schema = openapi_schema
return app.openapi_schema

app.openapi = custom_openapi


Expand Down

0 comments on commit 6a9ef5d

Please sign in to comment.