diff --git a/docs/source/data-publishing/ogcapi-features.rst b/docs/source/data-publishing/ogcapi-features.rst index 15ef4859b..ad2d397e5 100644 --- a/docs/source/data-publishing/ogcapi-features.rst +++ b/docs/source/data-publishing/ogcapi-features.rst @@ -109,7 +109,17 @@ To publish an Elasticsearch index, the following are required in your index: id_field: geonameid time_field: datetimefield -This provider has the support for the CQL queries as indicated in the table above. +.. note:: + + For Elasticseach indexes that are password protect, a RFC1738 URL can be used as follows: + + ``data: http://username:password@localhost:9200/ne_110m_populated_places_simple`` + + To further conceal authentication credentials, environment variables can be used: + + ``data: http://${MY_USERNAME}:${MY_PASSWORD}@localhost:9200/ne_110m_populated_places_simple`` + +The ES provider also has the support for the CQL queries as indicated in the table above. .. seealso:: :ref:`cql` for more details on how to use Common Query Language (CQL) to filter the collection with specific queries. diff --git a/docs/source/data-publishing/ogcapi-records.rst b/docs/source/data-publishing/ogcapi-records.rst index d310dbaeb..c29c082a1 100644 --- a/docs/source/data-publishing/ogcapi-records.rst +++ b/docs/source/data-publishing/ogcapi-records.rst @@ -15,12 +15,12 @@ pygeoapi core record providers are listed below, along with a matrix of supporte parameters. .. csv-table:: - :header: Provider, properties (filters), resulttype, q, bbox, datetime, sortby, properties (display), transactions + :header: Provider, properties (filters), resulttype, q, bbox, datetime, sortby, properties (display), CQL, transactions :align: left - `ElasticsearchCatalogue`_,✅,results/hits,✅,✅,✅,✅,❌ - `TinyDBCatalogue`_,✅,results/hits,✅,✅,✅,✅,✅ - `CSWFacade`_,✅,results/hits,✅,✅,✅,❌,❌ + `ElasticsearchCatalogue`_,✅,results/hits,✅,✅,✅,✅,✅,✅ + `TinyDBCatalogue`_,✅,results/hits,✅,✅,✅,✅,❌,✅ + `CSWFacade`_,✅,results/hits,✅,✅,✅,❌,❌,❌ Below are specific connection examples based on supported providers. @@ -51,6 +51,11 @@ To publish an Elasticsearch index, the following are required in your index: id_field: identifier time_field: datetimefield +The ES provider also has the support for the CQL queries as indicated in the table above. + +.. seealso:: + :ref:`cql` for more details on how to use Common Query Language (CQL) to filter the collection with specific queries. + TinyDBCatalogue ^^^^^^^^^^^^^^^