CMR-10502 refactors index.json to config.json

daniel-zamora · daniel-zamora · commit ffe9cac9abe0 · 2025-04-16T13:43:25.000-04:00
diff --git a/Generics.md b/Generics.md
@@ -29,14 +29,14 @@ Each setting consists of a key, which is the name for the Generic which must be
 
 	./{CMR-Root}/schemas/order-option/v0.0.1/
 		README.md
-		index.json
+		config.json
 		metadata.json
 		schema.json
 
 CMR will search for Generic definitions using the lower case value of the key (name) and the version number prefixed with a "v". Inside the directory there must be 4 files, three of which are directly read by CMR:
 
 * README.md - for humans
-* index.json - Search/Index configuration settings, must comply with [Index Schema][schema-index].
+* config.json - Search/Index/Validation configuration settings, must comply with [Config Schema][schema-config].
 * metadata.json - sample record, may be called by system-int-tests
 * schema.json - A schema document conforming to [JSON Schema][schema].
 
@@ -103,5 +103,5 @@ Copyright © 2014-2022 United States Government as represented by the Administra
 
 [schema]: https://json-schema.org "JSON Schema definition"
 [schema-other]: https://git.earthdata.nasa.gov/scm/emfd/otherschemas.git "Generic Schema Repository"
-[schema-index]: https://git.earthdata.nasa.gov/projects/EMFD/repos/otherschemas/browse/Index "Index configuration definition"
+[schema-config]: https://git.earthdata.nasa.gov/projects/EMFD/repos/otherschemas/browse/Config " "Generics Configuration definition"
 [semver]: https://semver.org "Information on semantic versioning"
diff --git a/common-lib/src/cmr/common/generics.clj b/common-lib/src/cmr/common/generics.clj
@@ -69,7 +69,7 @@
   "Return the specific schema given the schema keyword name and version number.
    Throw an error if the file can't be read.
    Parameters:
-   * file-name: [metadata | index | schema]
+   * file-name: [metadata | config | schema]
    * generic-keyword: [:grid | ...]
    * generic-version: 0.0.1
    Returns: string"
@@ -101,21 +101,21 @@
   "Cached - Return the specific schema given the schema keyword name and version number.
    Throw an error if the file can't be read.
    Parameters:
-   * file-name: [metadata | index | schema]
+   * file-name: [metadata | config | schema]
    * generic-keyword: [:grid | ...]
    * generic-version: 0.0.1
    Returns: string"
   (memoize read-schema-file*))
 
-(defn read-schema-index
-  "Return the schema index configuration file given the schema name and version
+(defn read-schema-config
+  "Return the schema config file given the schema name and version
    number. Throw an error if the file can't be read.
    Parameters:
    * generic-keyword: [:grid | ...]
    * generic-version: 0.0.1
    Returns: string"
   [generic-keyword generic-version]
-  (read-schema-file "index" generic-keyword generic-version))
+  (read-schema-file "config" generic-keyword generic-version))
 
 (defn read-schema-specification
   "Return the schema specification file given the schema name and version number.
@@ -151,35 +151,35 @@
          schema-obj (js-validater/json-string->json-schema schema-file)]
      (js-validater/validate-json schema-obj raw-json throw?))))
 
-(defn validate-index-against-schema
+(defn validate-config-against-schema
   "Validate a document, returns an array of errors if there are problems
    Parameters:
    * raw-json, json as a string to validate
    Returns: list of errors or nil"
   [raw-json]
-  (validate-metadata-against-schema raw-json :index "0.0.1"))
+  (validate-metadata-against-schema raw-json :config "0.0.1"))
 
 (defn- approved-generic-concept-prefixes*
   "Return the active list of approved generic content types with the defined
-   prefix in the :SubConceptType field found in the index.json file. If field is
+   prefix in the :SubConceptType field found in the config.json file. If field is
    not defined, then X is used.
    Parameters: none, based off approved-documents?
    Return: {doc-type \"concept-prefix\"}"
   []
   (reduce (fn [data item]
             (let [generic-keyword (first item)
-                  index-raw (read-schema-index generic-keyword (second item))
-                  parse-errors (validate-index-against-schema index-raw)]
+                  config-raw (read-schema-config generic-keyword (second item))
+                  parse-errors (validate-config-against-schema config-raw)]
               (when-not (some? parse-errors)
                 (assoc data
                        generic-keyword
-                       (get (json/parse-string index-raw true) :SubConceptType "X")))))
+                       (get (json/parse-string config-raw true) :SubConceptType "X")))))
           {}
           (latest-approved-documents)))
 
 (def approved-generic-concept-prefixes
   "Cached - Return the active list of approved generic content types with the defined
-   prefix in the :SubConceptType field found in the index.json file. If field is
+   prefix in the :SubConceptType field found in the config.json file. If field is
    not defined, then X is used.
    Parameters: none, based off approved-documents?
    Return: {doc-type \"concept-prefix\"}"
diff --git a/indexer-app/src/cmr/indexer/data/concepts/generic.clj b/indexer-app/src/cmr/indexer/data/concepts/generic.clj
@@ -101,7 +101,7 @@
                               (meta-db/get-generic-associations-for-concept context concept))
         gen-name (csk/->kebab-case (get-in parsed-concept [:MetadataSpecification :Name] ""))
         gen-ver (get-in parsed-concept [:MetadataSpecification :Version])
-        index-data-file (format "schemas/%s/v%s/index.json" gen-name gen-ver)
+        index-data-file (format "schemas/%s/v%s/config.json" gen-name gen-ver)
         index-file-raw (slurp (io/resource index-data-file))
         index-data (json/parse-string index-file-raw true)
         schema-keys [:LongName
@@ -173,7 +173,7 @@
         version (generics/current-generic-version concept-type)
         gen-name (csk/->kebab-case (get-in parsed-concept [:MetadataSpecification :Name] ""))
         gen-ver (get-in parsed-concept [:MetadataSpecification :Version])
-        index-data-file (format "schemas/%s/v%s/index.json" (name concept-type) version)
+        index-data-file (format "schemas/%s/v%s/config.json" (name concept-type) version)
         index-file-raw (slurp (io/resource index-data-file))
         index-data (json/parse-string index-file-raw true)
         common-doc ;; fields common to all generic documents
diff --git a/indexer-app/src/cmr/indexer/data/index_set_generics.clj b/indexer-app/src/cmr/indexer/data/index_set_generics.clj
@@ -15,7 +15,7 @@
    Parameters:
    * raw-json, json as a string to validate"
   [raw-json]
-  (let [schema-file (slurp (io/resource "schemas/index/v0.0.1/schema.json"))
+  (let [schema-file (slurp (io/resource "schemas/config/v0.0.1/schema.json"))
         schema-obj (js-validater/json-string->json-schema schema-file)]
     (js-validater/validate-json schema-obj raw-json)))
 
@@ -120,13 +120,13 @@
    if the file can't be read."
   [gen-name gen-version]
   (try
-    (-> "schemas/%s/v%s/index.json"
+    (-> "schemas/%s/v%s/config.json"
         (format (name gen-name) gen-version)
         (io/resource)
         (slurp))
     (catch Exception e
       (error
-       (format (str "The index.json file for schema [%s] version [%s] cannot be found. Please make sure that it exists."
+       (format (str "The config.json file for schema [%s] version [%s] cannot be found. Please make sure that it exists."
                     (.getMessage e))
                 gen-name
                 gen-version)))))
@@ -140,7 +140,7 @@
   (try
     (validate-index-against-schema raw-json)
     (catch java.lang.NullPointerException npe
-      (let [msg (format "%s : Null Pointer Exception while trying to validate index.json for %s."
+      (let [msg (format "%s : Null Pointer Exception while trying to validate config.json for %s."
                         (.getMessage npe)
                         schema)]
         (error msg)
@@ -169,7 +169,7 @@
    {:generic-grid
     {:indexes []
      :mapping {:properties {:index-key-name {:type 'type'}}}}}
-   If the matching index.json file is not valid, then that schema will be logged and skipped.
+   If the matching config.json file is not valid, then that schema will be logged and skipped.
    "
   []
   (reduce (fn [data gen-keyword]
@@ -191,7 +191,7 @@
                                    :settings generic-settings}]
                         :mapping {:properties (reduce mapping->index-key base-indexes index-list)}})
                 (do
-                  (error (format "Could not parse the index.json file for %s version %s."
+                  (error (format "Could not parse the config.json file for %s version %s."
                                  gen-name
                                  gen-ver))
                   data))))
@@ -200,7 +200,7 @@
 
 (comment
   ;; Since the change to distribute schemas files as a JAR makes it hard to test
-  ;; a bad index.json, add the following line after the index-definition-str
+  ;; a bad config.json, add the following line after the index-definition-str
   ;; declare in the let and run the function below
 
   ;index-definition-str (if (= :grid gen-keyword) "{bad-json}" index-definition-str)
diff --git a/ingest-app/src/cmr/ingest/validation/generic_document_validation.clj b/ingest-app/src/cmr/ingest/validation/generic_document_validation.clj
@@ -99,7 +99,7 @@
   [concept-type version]
   (try
     (if (generics/approved-generic? concept-type version)
-      (let [schema-json (generics/read-schema-index concept-type version)
+      (let [schema-json (generics/read-schema-config concept-type version)
             schema (json/parse-string schema-json true)]
         (fn [context concept]
           (validate-with-schema context concept schema)))
diff --git a/schemas/resources/schemas/citation/v1.0.0/config.json b/schemas/resources/schemas/citation/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/collection-draft/v1.0.0/config.json b/schemas/resources/schemas/collection-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/config/CHANGELOG.md b/schemas/resources/schemas/config/CHANGELOG.md
diff --git a/schemas/resources/schemas/config/README.md b/schemas/resources/schemas/config/README.md
@@ -1,4 +1,6 @@
-# Index Schema
+# Config Schema
 
 Define index fields that need to be indexed and the properties needed to create
 these indexes.
+
+Define validations on fields to be indexed.
diff --git a/schemas/resources/schemas/config/v0.0.1/metadata.json b/schemas/resources/schemas/config/v0.0.1/metadata.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-      "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-      "Name": "Generic-Index",
+      "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+      "Name": "Generic-Config",
       "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/config/v0.0.1/schema.json b/schemas/resources/schemas/config/v0.0.1/schema.json
@@ -1,7 +1,7 @@
 {
    "$id": "https://earthdata.nasa.gov/schema/generics/index",
    "$schema": "http://json-schema.org/draft-07/schema#",
-   "title": "Generic-Index",
+   "title": "Generic-Config",
    "description": "This scheme defines how index configurations are to be defined. These index definitions support both Elastic and Graph-DB",
    "type": "object",
    "additionalProperties": false,
@@ -68,12 +68,12 @@
                 "URL": {
                     "description": "This element represents the URL where the schema lives. The schema can be downloaded.",
                     "type": "string",
-                    "const": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1"
+                    "const": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1"
                 },
                 "Name": {
                     "description": "This element represents the name of the schema.",
                     "type": "string",
-                    "const": "Generic-Index"
+                    "const": "Generic-Config"
                 },
                 "Version": {
                     "description": "This element represents the version of the schema.",
diff --git a/schemas/resources/schemas/data-quality-summary-draft/v1.0.0/config.json b/schemas/resources/schemas/data-quality-summary-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/data-quality-summary/v1.0.0/config.json b/schemas/resources/schemas/data-quality-summary/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/grid-draft/v1.0.0/config.json b/schemas/resources/schemas/grid-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/grid/README.md b/schemas/resources/schemas/grid/README.md
@@ -8,12 +8,12 @@ are in the development phase.
 
 ## Files
 
-| Schema                   | Implementation | Notes       |
-| ------------------------ | -------------- | ----------- |
-| schema.json              | metadata.json  | In progress |
-| Index/v0.0.1/schema.json | index.json     | Proposed    |
-| n/a                      | migration.py   | Proposed    |
-| n/a                      | validation.py  | Proposed    |
+| Schema                    | Implementation  | Notes       |
+| ------------------------- | --------------- | ----------- |
+| schema.json               | metadata.json   | In progress |
+| Config/v0.0.1/schema.json | config.json     | Proposed    |
+| n/a                       | migration.py    | Proposed    |
+| n/a                       | validation.py   | Proposed    |
 
 ## License
 
diff --git a/schemas/resources/schemas/grid/v0.0.1/config.json b/schemas/resources/schemas/grid/v0.0.1/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-      "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-      "Name": "Generic-Index",
+      "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+      "Name": "Generic-Config",
       "Version": "0.0.1"
   },
     "Generic": {
diff --git a/schemas/resources/schemas/order-option-draft/v1.0.0/config.json b/schemas/resources/schemas/order-option-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/order-option/v1.0.0/config.json b/schemas/resources/schemas/order-option/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/service-draft/v1.0.0/config.json b/schemas/resources/schemas/service-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/service-entry/v1.0.0/config.json b/schemas/resources/schemas/service-entry/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/service-option/v1.0.0/config.json b/schemas/resources/schemas/service-option/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/tool-draft/v1.0.0/config.json b/schemas/resources/schemas/tool-draft/v1.0.0/config.json
@@ -1,7 +1,7 @@
 {
   "MetadataSpecification": {
-    "URL": "https://cdn.earthdata.nasa.gov/generic/index/v0.0.1",
-    "Name": "Generic-Index",
+    "URL": "https://cdn.earthdata.nasa.gov/generic/config/v0.0.1",
+    "Name": "Generic-Config",
     "Version": "0.0.1"
   },
   "Generic": {
diff --git a/schemas/resources/schemas/use-info.md b/schemas/resources/schemas/use-info.md
@@ -28,15 +28,15 @@ system or URL. Stick to lower case letters. Each schema directory contains a
 directories start with "v" and use [Semantic Versioning][semver].
 Each version directory then contains at the minimal a `metadata.json` and
 `schema.json` file. These must be valid together when validated. Optionally
-there can be an `index.json` file or other documents needed to support CMR.
+there can be an `config.json` file or other documents needed to support CMR.
 
 Example:
 
 * grid/
     * CHANGELOG.md
     * README.md
     * v0.0.1/
-        * index.json
+        * config.json
         * metadata.json
         * schema.json
 
diff --git a/schemas/resources/schemas/validate.py b/schemas/resources/schemas/validate.py
@@ -33,7 +33,7 @@ def test_index(schema_name):
   sub_folders = [f.path for f in os.scandir(schema_name) if f.is_dir()]
   for version in list(sub_folders):
     index_schema = f"{os.getcwd()}/index/v0.0.1/schema.json"
-    index = f"{os.getcwd()}/{version}/index.json"
+    index = f"{os.getcwd()}/{version}/config.json"
     ret = ret + validate_schema(jar, index_schema, index)
   return ret
 
diff --git a/schemas/resources/schemas/variable-draft/v1.0.0/config.json b/schemas/resources/schemas/variable-draft/v1.0.0/config.json
diff --git a/schemas/resources/schemas/visualization/v1.0.0/config.json b/schemas/resources/schemas/visualization/v1.0.0/config.json
diff --git a/schemas/resources/schemas/visualization/v1.1.0/config.json b/schemas/resources/schemas/visualization/v1.1.0/config.json
diff --git a/system-int-test/test/cmr/system_int_test/ingest/misc/generic_document_validation_test.clj b/system-int-test/test/cmr/system_int_test/ingest/misc/generic_document_validation_test.clj
