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>
65 lines
1.2 KiB
ReStructuredText
65 lines
1.2 KiB
ReStructuredText
.. _index:
|
|
|
|
.. image:: /_static/pygeoapi-logo.png
|
|
:scale: 50%
|
|
:alt: pygeoapi logo
|
|
|
|
pygeoapi |release| documentation
|
|
==================================
|
|
|
|
.. image:: https://zenodo.org/badge/121585259.svg
|
|
:target: https://zenodo.org/badge/latestdoi/121585259
|
|
|
|
:Author: the pygeoapi team
|
|
:Contact: pygeoapi at lists.osgeo.org
|
|
:Release: |release|
|
|
:Date: |today|
|
|
|
|
|
|
Welcome to the official pygeoapi documentation! Here you will find complete
|
|
reference documentation on all aspects of the project.
|
|
|
|
.. note::
|
|
|
|
Did you know about the `pygeoapi workshop`_? Ready to get your hands dirty? Dive in!
|
|
|
|
.. toctree::
|
|
:maxdepth: 4
|
|
:caption: Table of Contents
|
|
:name: toc
|
|
|
|
introduction
|
|
how-pygeoapi-works
|
|
installation
|
|
configuration
|
|
administration
|
|
running
|
|
running-with-docker
|
|
tour
|
|
openapi
|
|
data-publishing/index
|
|
transactions
|
|
admin-api
|
|
plugins
|
|
html-templating
|
|
crs
|
|
cql
|
|
language
|
|
development
|
|
ogc-compliance
|
|
contributing
|
|
support
|
|
further-reading
|
|
license
|
|
|
|
api-documentation
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. _`pygeoapi workshop`: https://dive.pygeoapi.io
|