generate openapi, if not available during server start

geopython / pygeoapi

pygeoapi is a Python server implementation of the OGC API suite of standards. The project emerged as part of the next generation OGC API efforts in 2018 and provides the capability for organizations to deploy a RESTful OGC API endpoint using OpenAPI, GeoJSON, and HTML. pygeoapi is open source and released under an MIT license.

https://pygeoapi.io

MIT License

488 stars 261 forks source link

generate openapi, if not available during server start #1650

Closed pvgenuchten closed 2 months ago

pvgenuchten commented 4 months ago

Is your feature request related to a problem? Please describe.

if one runs pygeoapi serve without the open api document being generated, or env variable not set, the following error is thrown:

TypeError: expected str, bytes or os.PathLike object, not NoneType

Describe the solution you'd like

[x] Provide a better error to user: 'please initialise open api document first'
[ ] Generate the actual document if detected it is not available (or out of date)

tomkralidis commented 2 months ago

@pvgenuchten PR in #1758 for your review. Note that "automatic" OpenAPI generation is not implemented (IMHO would be safer to have this as an offline process overall).