Merge pull request #1339 from opendatacube/schema-required

update metadata type schema and docs
opendatacube · Nov 1, 2022 · f31812e · f31812e
2 parents f763038 + 71758ba
commit f31812e
Show file tree

Hide file tree

Showing 5 changed files with 475 additions and 448 deletions.
diff --git a/datacube/model/schema/metadata-type-schema.yaml b/datacube/model/schema/metadata-type-schema.yaml
@@ -53,6 +53,7 @@ properties:
             - creation_dt
             - label
             - sources
+            - search_fields
         additionalProperties: false
 required:
     - name

diff --git a/docs/about-core-concepts/metadata-types.rst b/docs/about-core-concepts/metadata-types.rst
@@ -1,2 +1,11 @@
 Metadata Types
 ==============
+
+.. literalinclude:: ../config_samples/metadata_types/bare_bone.yaml
+   :language: yaml
+
+.. note::
+
+    Metadata type yaml file must contain name, description and dataset keys.
+
+    Dataset key must contain id, sources, creation_dt, label and search_fields keys.
diff --git a/docs/about/whats_new.rst b/docs/about/whats_new.rst
@@ -15,6 +15,7 @@ v1.8.next
 - Add `rst` documentation lint github action and apply best practices (:pull:`1328`)
 - Follow PEP561_ to make type hints available to other packages (:issue:`1330`)
 - Add what's new page link to menu and general doc fixes (:pull:`1335`)
+- Add `search_fields` to required for metadata type schema and update doc (:pull:`1339`)
 
 .. _PEP561: https://peps.python.org/pep-0561/