Benjamin Webb
8e122d1a61
* Add Admin API
- Create `admin.py` to serve as Admin API Core
- Create `flask_admin.py` to create flask blueprint for admin API
- Consolidate configuration getter
- Add Pathlib serializing
- Add docker example
* Add integration tests
- Amend admin example to allow writing to configuration. If FS is read only admin API does not work. Returns a 500 and logs `OSError: [Errno 30] Read-only file system: '/pygeoapi/local.config.yml' `
* Preserve env variables in configuration
* Use common accessor functions
- Use common configuration accessor methods for Django and Starlette
* GET returns raw config file
Return configuration with environment variables preserved on GET requests
* Safeguard env variables for root cfg view
"bind": {
"host": "localhost",
"port": "6000"
}
->
"bind": {
"host": "${HOST}",
"port": "${PORT}"
}
* Simplify admin HTML imports
- Use jinja recursion to expand the configuration
- Remove vue from templates
* Create admin API documentation
* Use render_item_value in admin template
* Add Admin API
- Create `admin.py` to serve as Admin API Core
- Create `flask_admin.py` to create flask blueprint for admin API
- Consolidate configuration getter
- Add Pathlib serializing
- Add docker example
* Update GitHub Actions deployment
* Update admin entrypoint
Update admin entrypoint to align with upstream pygeoapi implementation
* Make requested changes
Co-Authored-By: Tom Kralidis <tomkralidis@gmail.com>
* Amend test url
Co-Authored-By: Tom Kralidis <tomkralidis@gmail.com>
* Fix Admin CI tests
* Add PUT and PATCH for root configuration
- Add put and patch for root configuration
- Add CI tests for PUT and PATCH of root
* Update OpenAPI document wording
* Update entrypoint.sh
Replace tabs with spaces
* Remove unused step
Error from rebasing. Admin API tests are moved to their own job.
* Use jsonpatch
- Use debian supported packaging
- Use custom merge function
* Move test data location
* Create Starlette and Django app
- Fold flask_admin.py into flask_app.py
Co-Authored-By: Tom Kralidis <tomkralidis@gmail.com>
* Make requirements-admin.txt
Move admin dependencies to requirements-admin.txt
* Delete guiblock.html
* Update test count for STAC
Update expected test count for addt'l admin test data
* Relegate config warning to config.py
* Move admin tests out of example
* Delete admin docker example
* Update admin-api.rst
* Update pygeoapi-config-0.x.yml
* Update configuration.rst
* Update config.py
* Update admin.py
* Update admin.py
---------
Co-authored-by: Tom Kralidis <tomkralidis@gmail.com>
31 lines
950 B
ReStructuredText
31 lines
950 B
ReStructuredText
.. _admin-api:
|
|
|
|
Admin API
|
|
=========
|
|
|
|
pygeoapi provides the ability to manage configuration through an API.
|
|
|
|
When enabled, :ref:`transactions` can be made on pygeoapi's configured resources. This allows for API based modification of the pygeoapi configuration.
|
|
|
|
The API is enabled with the following server configuration:
|
|
|
|
.. code-block:: yaml
|
|
|
|
server:
|
|
admin: true # boolean on whether to enable Admin API.
|
|
|
|
For pygeoapi to hot reload the configuration as changes are made, the pygeoapi configuration file must be included as
|
|
demonstrated for a gunicorn deployment of pygeoapi via flask:
|
|
|
|
.. code-block:: bash
|
|
|
|
gunicorn \
|
|
--workers ${WSGI_WORKERS} \
|
|
--worker-class=${WSGI_WORKER_CLASS} \
|
|
--timeout ${WSGI_WORKER_TIMEOUT} \
|
|
--name=${CONTAINER_NAME} \
|
|
--bind ${CONTAINER_HOST}:${CONTAINER_PORT} \
|
|
--reload \
|
|
--reload-extra-file ${PYGEOAPI_CONFIG} \
|
|
pygeoapi.flask_app:APP
|