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

OpenAPI: skip failing collections (#1577) #1585

Merged
merged 2 commits into from
Mar 11, 2024
Merged

OpenAPI: skip failing collections (#1577) #1585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd476b6
OpenAPI: skip failing collections (#1577)
tomkralidis Mar 9, 2024
8b9056e
add flag to fail/no fail on invalid collections
tomkralidis Mar 9, 2024
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
4 changes: 4 additions & 0 deletions docs/source/administration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ To generate the OpenAPI document as JSON, run:
property names and their data types. Whenever you make changes to your pygeoapi configuration,
always refresh the accompanying OpenAPI document.

.. note::
By default, pygeoapi OpenAPI document generation will fail on any collection whose provider is improperly
configured or when encountering a connection issue. To skip failing collections, use the
--no-fail-on-invalid-collection flag. The OpenAPI document will then be generated without the failing collection(s)

.. seealso::
:ref:`openapi` for more information on pygeoapi's OpenAPI support
Expand Down
2 changes: 1 addition & 1 deletion docs/source/openapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The official OpenAPI specification can be found `on GitHub <https://github.com/O
pygeoapi supports OpenAPI version 3.0.2.

As described in :ref:`administration`, the pygeoapi OpenAPI document is automatically generated based on the
configuration file:
configuration file.

The API is accessible at the ``/openapi`` endpoint, providing a Swagger-based webpage of the API description..

Expand Down
Loading
Loading