feat(views): include example;

- Allow including examples for published resource schemas.

Author: JVickery-TBS

changes/0017.changes

@@ -0,0 +1 @@
+Added `include_example` URI parameter option to the `published_schema_json` route to allow for more robust DEPs.

ckanext/recombinant/views.py

@@ -441,7 +441,8 @@ def published_data_dictionary(dataset_type: str) -> Response:
     return _data_dictionary(dataset_type, published_resource=True)
 
 
-def _schema_json(dataset_type: str, published_resource: bool = False) -> Response:
+def _schema_json(dataset_type: str, published_resource: bool = False,
+                 include_example: bool = True) -> Response:
     try:
         geno = get_geno(dataset_type)
     except RecombinantException:
@@ -526,7 +527,7 @@ def _schema_json(dataset_type: str, published_resource: bool = False) -> Respons
                 for ck, cv in choice_fields[fld['id']]:
                     choices[ck] = cv
 
-        if not published_resource and 'examples' in chromo:
+        if include_example and 'examples' in chromo:
             ex_record = chromo['examples']['record']
             example = {}
             for field in chromo['fields']:
@@ -554,7 +555,9 @@ def schema_json(dataset_type: str) -> Response:
 @recombinant.route('/recombinant-published-schema/<dataset_type>.json')
 @nocache_store
 def published_schema_json(dataset_type: str) -> Response:
-    return _schema_json(dataset_type, published_resource=True)
+    include_example = asbool(request.args.get('include_example', False))
+    return _schema_json(dataset_type, published_resource=True,
+                        include_example=include_example)
 
 
 @recombinant.route('/recombinant/<resource_name>')