ESMCat pydantic Model: make id optional (intake#398)

aulemahal · Nov 18, 2021 · ead1c1c · ead1c1c
1 parent 50b15c5
commit ead1c1c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -8,12 +8,12 @@
 
 ## Badges
 
-| CI           | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![GitHub Workflow Status][github-lint-badge]][github-lint-link] [![Code Coverage Status][codecov-badge]][codecov-link] |
-| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-| **Docs**     |                                                                    [![Documentation Status][rtd-badge]][rtd-link]                                                                    |
-| **Package**  |                                                         [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link]                                                         |
-| **License**  |                                                                        [![License][license-badge]][repo-link]                                                                        |
-| **Citation** |                                                                        [![Zenodo][zenodo-badge]][zenodo-link]                                                                        |
+| CI           | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] |
+| :----------- | :-----------------------------------------------------------------------------------------------------------------: |
+| **Docs**     |                                   [![Documentation Status][rtd-badge]][rtd-link]                                    |
+| **Package**  |                        [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link]                         |
+| **License**  |                                       [![License][license-badge]][repo-link]                                        |
+| **Citation** |                                       [![Zenodo][zenodo-badge]][zenodo-link]                                        |
 
 ## Motivation
 
@@ -94,9 +94,7 @@ conda install -c conda-forge intake-esm
 ```
 
 [github-ci-badge]: https://img.shields.io/github/workflow/status/intake/intake-esm/CI?label=CI&logo=github&style=for-the-badge
-[github-lint-badge]: https://img.shields.io/github/workflow/status/intake/intake-esm/linting?label=linting&logo=github&style=for-the-badge
 [github-ci-link]: https://github.com/intake/intake-esm/actions?query=workflow%3ACI
-[github-lint-link]: https://github.com/intake/intake-esm/actions?query=workflow%3Alinting
 [codecov-badge]: https://img.shields.io/codecov/c/github/intake/intake-esm.svg?logo=codecov&style=for-the-badge
 [codecov-link]: https://codecov.io/gh/intake/intake-esm
 [rtd-badge]: https://img.shields.io/readthedocs/intake-esm/latest.svg?style=for-the-badge

diff --git a/intake_esm/cat.py b/intake_esm/cat.py
@@ -83,10 +83,10 @@ class ESMCatalogModel(pydantic.BaseModel):
     """
 
     esmcat_version: pydantic.StrictStr
-    id: str
     attributes: typing.List[Attribute]
     assets: Assets
     aggregation_control: AggregationControl
+    id: typing.Optional[str] = ''
     catalog_dict: typing.Optional[typing.List[typing.Dict]] = None
     catalog_file: pydantic.StrictStr = None
     description: pydantic.StrictStr = None

diff --git a/tests/sample-collections/cesm1-lens-zarr.json b/tests/sample-collections/cesm1-lens-zarr.json
@@ -1,6 +1,6 @@
 {
   "esmcat_version": "0.1.0",
-  "id": "sample-cesm1-lens-aws",
+  "id": null,
   "description": "This is a sample ESM collection for CESM1-LENS data in zarr format",
   "catalog_file": "./tests/sample-collections/cesm1-lens-aws-zarr.csv",
   "attributes": [