Skip to content

Commit d8a1b74

Browse files
authored
OpenAPI: skip failing collections (#1577) (#1585)
1 parent d128d52 commit d8a1b74

3 files changed

Lines changed: 985 additions & 916 deletions

File tree

docs/source/administration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ To generate the OpenAPI document as JSON, run:
4949
property names and their data types. Whenever you make changes to your pygeoapi configuration,
5050
always refresh the accompanying OpenAPI document.
5151

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

5357
.. seealso::
5458
:ref:`openapi` for more information on pygeoapi's OpenAPI support

docs/source/openapi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The official OpenAPI specification can be found `on GitHub <https://github.com/O
1313
pygeoapi supports OpenAPI version 3.0.2.
1414

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

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

0 commit comments

Comments
 (0)