- added example to update admin config, on Open API

Author: doublebyte1

pygeoapi/openapi.py

@@ -509,7 +509,7 @@ def get_oas_30(cfg: dict, fail_on_invalid_collection: bool = True) -> dict:
         schema_dict = get_config_schema()
         oas['definitions'] = schema_dict['definitions']
         LOGGER.debug('Adding admin endpoints')
-        oas['paths'].update(get_admin())
+        oas['paths'].update(get_admin(cfg))
 
     return oas
 
@@ -665,8 +665,12 @@ def get_config_schema():
     with open(schema_file) as fh2:
         return yaml_load(fh2)
 
+def get_admin(cfg: dict) -> dict:
+    """
+    Generates an OpenAPI definition for the admin UI
 
-def get_admin():
+    :param cfg: `dict` of configuration
+    """
 
     schema_dict = get_config_schema()
 
@@ -702,6 +706,7 @@ def get_admin():
                 'description': 'Updates admin configuration',
                 'content': {
                     'application/json': {
+                        'example': schema_dict['properties']['server']['properties']['admin-post-example'],
                         'schema': schema_dict
                     }
                 },
@@ -810,7 +815,7 @@ def get_admin():
                 'description': 'Updates admin configuration resource',
                 'content': {
                     'application/json': {
-                        'schema': schema_dict['properties']['resources']['patternProperties']['^.*$']  # noqa
+                        'schema': schema_dict['properties']['resources']['patternProperties']['^.*$'],  # noqa
                     }
                 },
                 'required': True

pygeoapi/schemas/config/pygeoapi-config-0.x.yml

@@ -27,8 +27,111 @@ properties:
                 description: URL of server (as used by client)
             admin:
                 type: boolean
-                description: whether to enable the Admin API (default is false)
                 default: false
+            admin-post-example:
+                server:
+                    bind:
+                        host: 0.0.0.0
+                        port: 5000
+                    url: http://localhost:5000
+                    mimetype: application/json; charset=UTF-8
+                    encoding: utf-8
+                    gzip: false
+                    languages:
+                        - en-US
+                        - fr-CA
+                    # cors: true
+                    pretty_print: true
+                    limit: 10
+                    map:
+                        url: https://tile.openstreetmap.org/{z}/{x}/{y}.png
+                        attribution: '&copy; <a href="https://openstreetmap.org/copyright">OpenStreetMap contributors</a>'                    
+                    admin: true
+                logging:
+                    level: ERROR
+
+                metadata:
+                    identification:
+                        title:
+                            en: New pygeoapi Title
+                            fr: instance par défaut de pygeoapi
+                        description:
+                            en: pygeoapi provides an API to geospatial data
+                            fr: pygeoapi fournit une API aux données géospatiales
+                        keywords:
+                            en:
+                                - geospatial
+                                - data
+                                - api
+                            fr:
+                                - géospatiale
+                                - données
+                                - api
+                        keywords_type: theme
+                        terms_of_service: https://creativecommons.org/licenses/by/4.0/
+                        url: https://example.org
+                    license:
+                        name: CC-BY 4.0 license
+                        url: https://creativecommons.org/licenses/by/4.0/
+                    provider:
+                        name: Organization Name
+                        url: https://pygeoapi.io
+                    contact:
+                        name: Lastname, Firstname
+                        position: Position Title
+                        address: Mailing Address
+                        city: City
+                        stateorprovince: Administrative Area
+                        postalcode: Zip or Postal Code
+                        country: Country
+                        phone: +xx-xxx-xxx-xxxx
+                        fax: +xx-xxx-xxx-xxxx
+                        email: [email protected]
+                        url: Contact URL
+                        hours: Mo-Fr 08:00-17:00
+                        instructions: During hours of service. Off on weekends.
+                        role: pointOfContact
+
+                resources:
+                    obs:
+                        type: collection
+                        title: Observations
+                        description: My cool observations
+                        keywords:
+                            - observations
+                            - monitoring
+                        linked-data:
+                            context:
+                                - datetime: https://schema.org/DateTime
+                                - vocab: https://example.com/vocab#
+                                  stn_id: "vocab:stn_id"
+                                  value: "vocab:value"
+                        links:
+                            - type: text/csv
+                              rel: canonical
+                              title: data
+                              href: https://github.com/mapserver/mapserver/blob/branch-7-0/msautotest/wxs/data/obs.csv
+                              hreflang: en-US
+                            - type: text/csv
+                              rel: alternate
+                              title: data
+                              href: https://raw.githubusercontent.com/mapserver/mapserver/branch-7-0/msautotest/wxs/data/obs.csv
+                              hreflang: en-US
+                        extents:
+                            spatial:
+                                bbox: [-180,-90,180,90]
+                                crs: http://www.opengis.net/def/crs/OGC/1.3/CRS84
+                            temporal:
+                                begin: 2000-10-30T18:24:39Z
+                                end: 2007-10-30T08:57:29Z
+                        providers:
+                            - type: feature
+                              name: CSV
+                              data: tests/data/obs.csv
+                              id_field: id
+                              geometry:
+                                x_field: long
+                                y_field: lat
             mimetype:
                 type: string
                 description: default MIME type