adiwg-json_schemas 0.9.1 → 0.9.2

data/examples/full_example.json

@@ -1,7 +1,7 @@
 {
   "version":{
-    "name":"adiwgJson",
-    "version":"0.9.0"
+    "name":"mdJson",
+    "version":"0.9.2"
   },
   "contact":[
     {
@@ -2286,5 +2286,416 @@
         }
       }
     ]
+  },
+  "dataDictionary": {
+    "dictionaryInfo": {
+      "citation": {
+        "title": "Project Metadata Database",
+        "date": [
+          {
+            "date": "2014-11-24",
+            "dateType": "creation"
+          }
+        ],
+        "edition": "14.0.2",
+        "responsibleParty": [
+          {
+            "contactId": "8",
+            "role": "author"
+          }
+        ]
+      },
+      "description": "Data dictionary for the ADIwg project metadata standard for 2011 based on the FGDC standard.",
+      "resourceType": "database",
+      "language": "eng; US"
+    },
+    "domain": [
+      {
+        "domainId": "domain001",
+        "commonName": "agency type",
+        "codeName": "AGENCY_TYPE",
+        "description": "Legal classification for the organization.",
+        "member": [
+          {
+            "name": "federal government",
+            "value": "federal",
+            "definition": "An organization withing the federal government."
+          }, {
+            "name": "state government",
+            "value": "state",
+            "definition": "An organization withing a state or provincial government."
+          }, {
+            "name": "local government",
+            "value": "local",
+            "definition": "An organization withing a local county, city, or municipal government."
+          }, {
+            "name": "private business",
+            "value": "private",
+            "definition": "A private for-profit business."
+          }, {
+            "name": "non-profit business",
+            "value": "nonProfit",
+            "definition": "A private non-profit business."
+          }, {
+            "name": "academic institute",
+            "value": "academic",
+            "definition": "An organization of higher learning such as a college or university."
+          }, {
+            "name": "military",
+            "value": "military",
+            "definition": "An organization within a recognized military structure such as the Army. Navy, or Air Force."
+          }
+        ]
+      }, {
+        "domainId": "domain002",
+        "commonName": "agency address type",
+        "codeName": "ADDRESS_TYPE",
+        "description": "Type of agency address.",
+        "member": [
+          {
+            "name": "mailing address",
+            "value": "mailing",
+            "definition": "The preferred address for receiving mail.  May be a physical address or P.O. Box."
+          }, {
+            "name": "physical address",
+            "value": "physical",
+            "definition": "The street address of the agency."
+          }
+        ]
+      }, {
+        "domainId": "domain003",
+        "commonName": "sky cover code",
+        "codeName": "sky_cover_code",
+        "description": "NH (Amount of the sky covered by all clouds) is part of the Cloud/WX mandatory 9 digit group. All nine digits must be entered, regardless of the presence or absence of clouds or significant weather conditions. Cloud/WX group format: NH CL h CM CH W W W W",
+        "member": [
+          {
+            "name": "0",
+            "value": "0",
+            "definition": "clear skys"
+          }, {
+            "name": "1",
+            "value": "1",
+            "definition": "1 okta or less, 1/10 or less, but not zero"
+          }, {
+            "name": "2",
+            "value": "2",
+            "definition": "2 oktas 2/10 - 3/10"
+          }, {
+            "name": "7",
+            "value": "7",
+            "definition": "7 oktas or more, 9/10 or more, but not 8 oktas but not 10/10"
+          }, {
+            "name": "8",
+            "value": "8",
+            "definition": "8 oktas, 10/10"
+          }, {
+            "name": "9",
+            "value": "9",
+            "definition": "Sky obscured by for and/or other meteorolocial phenonena / Cloud cover is indiscernible for reasons other than for or other meteorological phenomena such as smoke, or observation is not made."
+          }
+        ]
+      }, {
+        "domainId": "domain004",
+        "commonName": "low cloud type",
+        "codeName": "low_cloud_cover_type",
+        "description": "CL (low cloud type) is part of the Cloud/WX mandatory 9 digit group. All nine digits must be entered, regardless of the presence or absence of clouds or significant weather conditions. CL = type of low cloud, based on the priority given. A solidus (/) is reported if CL clouds are not visible owing to fog or similar obscuring phenomena. Cloud/WX group format: NH CL h CM CH W W W W",
+        "member": [
+          {
+            "name": "0",
+            "value": "0",
+            "definition": "No CL clouds -- no cumulus, cumulonimbus, stratocumulus, or stratus."
+          }, {
+            "name": "3",
+            "value": "3",
+            "definition": "If cumulonimbus are present, with or without other clouds, CL=3 if the upper part of none of the cumulonimbus clouds present is clearly fibrous or striated."
+          }, {
+            "name": "4",
+            "value": "4",
+            "definition": "If no cumulonimbus present, CL=4 if stratocumulus formed by the spreading out of cumulus is present."
+          }, {
+            "name": "8",
+            "value": "8",
+            "definition": "If no cumulonimbus present, CL=8 if the CL code figure 4 is not applicable and if cumulus and stratocumulus clouds with bases at different levels are present."
+          }, {
+            "name": "9",
+            "value": "9",
+            "definition": "If cumulonimbus are present, with or without other clouds, CL=9 if the upper part of at least one of the cumulonimbus clouds present is clearly fibrous or striated."
+          }, {
+            "name": "\/",
+            "value": "\/",
+            "definition": "CL clouds are not visible owing to fog or similar obscuring phenomena."
+          }
+        ]
+      }
+    ],
+    "entity": [
+      {
+        "entityId": "entity001",
+        "commonName": "agency",
+        "codeName": "AGENCY",
+        "definition": "Organizations providing some contribution to Alaska Science Center research.",
+        "primaryKeyAttributeCodeName": ["agency_id"],
+        "index": [
+          {
+            "codeName": "ui_agencyCode",
+            "allowDuplicates": false,
+            "attributeCodeName": ["agency_code"]
+          }
+        ],
+        "attribute": [
+          {
+            "commonName": "agency ID",
+            "codeName": "agency_id",
+            "definition": "Unique sequential ID for the agency assigned by the database.",
+            "dataType": "integer",
+            "allowNull": false
+          }, {
+            "commonName": "agency code",
+            "codeName": "agency_code",
+            "definition": "Unique alphanumeric ID for the agency assigned by the data steward.",
+            "dataType": "varchar(25)",
+            "allowNull": false,
+            "domainId": "domain001"
+          }, {
+            "commonName": "agency type code",
+            "codeName": "agency_type_code",
+            "definition": "Agency legal organization classification.",
+            "dataType": "varchar(25)",
+            "allowNull": false
+          }, {
+            "commonName": "agency name",
+            "codeName": "agency_name",
+            "definition": "Name of agency.",
+            "dataType": "varchar(100)",
+            "allowNull": false
+          }, {
+            "commonName": "agency comment",
+            "codeName": "comment",
+            "definition": "Supplemental information about the agency.",
+            "dataType": "varchar(500)",
+            "allowNull": true
+          }, {
+            "commonName": "time stamp",
+            "codeName": "ts",
+            "definition": "datetime of creation or latest update - maintained by system",
+            "dataType": "datetime",
+            "allowNull": false
+          }
+        ]
+      }, {
+        "entityId": "entity002",
+        "commonName": "agency address",
+        "codeName": "ADDRESS",
+        "definition": "Addresses for an AGENCY",
+        "primaryKeyAttributeCodeName": ["agency_id", "address_type_code"],
+        "attribute": [
+          {
+            "commonName": "agency ID",
+            "codeName": "agency_id",
+            "definition": "Unique sequential ID for the agency assigned by the database.",
+            "dataType": "integer",
+            "allowNull": false
+          }, {
+            "commonName": "address type",
+            "codeName": "address_type_code",
+            "definition": "Type of address.",
+            "dataType": "varchar(25)",
+            "allowNull": false,
+            "domainId": "domain002"
+          }, {
+            "commonName": "street address",
+            "codeName": "street",
+            "definition": "Street and street number or P.O. Box number.",
+            "dataType": "varchar(100)",
+            "allowNull": false
+          }, {
+            "commonName": "city",
+            "codeName": "city",
+            "definition": "City name.",
+            "dataType": "varchar(50)",
+            "allowNull": false
+          }, {
+            "commonName": "state",
+            "codeName": "state_code",
+            "definition": "State or province code",
+            "dataType": "char(3)",
+            "allowNull": false
+          }, {
+            "commonName": "zip code",
+            "codeName": "postal_code",
+            "definition": "Postal code.",
+            "dataType": "char(9)",
+            "allowNull": true
+          }
+        ],
+        "foreignKey": [
+          {
+            "localAttributeCodeName": ["agency_id"],
+            "referencedEntityCodeName": "AGENCY",
+            "referencedAttributeCodeName": ["agency_id"]
+          }
+        ]
+      }, {
+        "entityId": "entity003",
+        "commonName": "weather station",
+        "codeName": "WEATHER_STATION",
+        "definition": "Table describing weather permanent and semi-permanent weather all-season recording stations in Alaska.",
+        "primaryKeyAttributeCodeName": ["station_id"],
+        "attribute": [
+          {
+            "commonName": "weather station id",
+            "codeName": "station_id",
+            "definition": "Unique identifier for weather station.",
+            "dataType": "integer",
+            "allowNull": false
+          }, {
+            "commonName": "weather station name",
+            "codeName": "station_name",
+            "definition": "Common name for the weather station.",
+            "dataType": "varchar(100)",
+            "allowNull": false
+          }, {
+            "commonName": "station latitude",
+            "codeName": "latitude",
+            "definition": "Latitude of weather station.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "degree",
+            "minValue": "-90.0",
+            "maxValue": "90.0"
+          }, {
+            "commonName": "station longitude",
+            "codeName": "longitude",
+            "definition": "Longitude of weather station.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "degree",
+            "minValue": "-180.0",
+            "maxValue": "180.0"
+          }, {
+            "commonName": "station elevation",
+            "codeName": "elevation_M",
+            "definition": "Elevation of weather station above sea level in meters.",
+            "dataType": "decimal",
+            "allowNull": true,
+            "units": "meter",
+            "minValue": "0",
+            "maxValue": "3000"
+          }
+        ]
+      }, {
+        "entityId": "entity004",
+        "commonName": "weather station observation",
+        "codeName": "WEATHER_STATION_OBSERVATION",
+        "definition": "Table of discontinuous weather station observation records including temperature, humidity, wind, precipitation, and cloud cover.",
+        "primaryKeyAttributeCodeName": ["obs_id"],
+        "attribute": [
+          {
+            "commonName": "weather observation ID",
+            "codeName": "obs_id",
+            "definition": "Unique identifier of a single weather station observation record.",
+            "dataType": "integer",
+            "allowNull": false
+          }, {
+            "commonName": "weather station ID",
+            "codeName": "station_id",
+            "definition": "Unique identifier for weather station.",
+            "dataType": "integer",
+            "allowNull": false
+          }, {
+            "commonName": "observation date and time",
+            "codeName": "obs_datetime",
+            "definition": "Date and UTC with offset 24h time the weather observation was made.",
+            "dataType": "datetime",
+            "allowNull": false
+          }, {
+            "commonName": "ambient air temperature Celsius",
+            "codeName": "air_temp_C",
+            "definition": "Ambient air temperature recorded at weather station in degrees Celsius.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "degC",
+            "minValue": "-60",
+            "maxValue": "50"
+          }, {
+            "commonName": "ambient air temperature Fahrenheit",
+            "codeName": "air_temp_F",
+            "definition": "Ambient air temperature recorded at weather station in degrees Fahrenheit.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "degF",
+            "minValue": "-100",
+            "maxValue": "130"
+          }, {
+            "commonName": "daily precipitation",
+            "codeName": "precipitation_IN",
+            "definition": "The amount of rain fall or snow melt falling in a 24 hour period in inches.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "inch",
+            "minValue": "0",
+            "maxValue": "25"
+          }, {
+            "commonName": "daily precipitation",
+            "codeName": "precipitation_mm",
+            "definition": "The amount of rain fall or snow melt falling in a 24 hour period in millimeters.",
+            "dataType": "decimal",
+            "allowNull": false,
+            "units": "mm",
+            "minValue": "0",
+            "maxValue": "500"
+          }, {
+            "commonName": "wind direction",
+            "codeName": "wind_direction_DEG",
+            "definition": "Average direction wind is coming from in degrees. True north is 0 degrees.",
+            "dataType": "integer",
+            "allowNull": true,
+            "units": "degree",
+            "minValue": "0",
+            "maxValue": "359"
+          }, {
+            "commonName": "wind speed",
+            "codeName": "wind_speed_MPH",
+            "definition": "Average wind speed in miles per hour (MPH).",
+            "dataType": "integer",
+            "allowNull": true,
+            "units": "mph",
+            "minValue": "0",
+            "maxValue": "200"
+          }, {
+            "commonName": "wind speed",
+            "codeName": "wind_speed_KPH",
+            "definition": "Average wind speed in kilometers per hour (KPH).",
+            "dataType": "integer",
+            "allowNull": true,
+            "units": "kph",
+            "minValue": "0",
+            "maxValue": "300"
+          }, {
+            "commonName": "sky cover code",
+            "codeName": "sky_cover_code",
+            "definition": "NH (Amount of the sky covered by all clouds) is part of the Cloud/WX mandatory 9 digit group. All nine digits must be entered, regardless of the presence or absence of clouds or significant weather conditions. Cloud/WX group format: NH CL h CM CH W W W W",
+            "dataType": "char(1)",
+            "allowNull": true,
+            "units": "sunnyDays",
+            "domainId": "domain003"
+          }, {
+            "commonName": "low cloud type",
+            "codeName": "low_cloud_cover_code",
+            "definition": "CL (low cloud type) is part of the Cloud/WX mandatory 9 digit group. All nine digits must be entered, regardless of the presence or absence of clouds or significant weather conditions. CL = type of low cloud, based on the priority given. A solidus (/) is reported if CL clouds are not visible owing to fog or similar obscuring phenomena. Cloud/WX group format: NH CL h CM CH W W W W",
+            "dataType": "char(1)",
+            "allowNull": true,
+            "domainId": "domain004"
+          }
+        ],
+        "foreignKey": [
+          {
+            "localAttributeCodeName": ["station_id"],
+            "referencedEntityCodeName": "WEATHER_STATION",
+            "referencedAttributeCodeName": ["station_id"]
+          }
+        ]
+      }
+    ]
   }
-}
+}

data/examples/full_example2.json

@@ -1,6 +1,6 @@
 {
   "version":{
-    "name":"adiwgJson",
+    "name":"mdJson",
     "version":"0.9.0"
   },
   "contact":[

data/examples/lcc_project_example.json

@@ -1,6 +1,6 @@
 {
   "version":{
-    "name":"adiwgJson",
+    "name":"mdJson",
     "version":"0.9.0"
   },
   "contact":[

data/examples/minimum_example.json

@@ -1,6 +1,6 @@
 {
   "version": {
-    "name": "adiwgJson",
+    "name": "mdJson",
     "version": "0.9.0"
   },
   "contact": [

data/lib/adiwg/json_schemas/version.rb

@@ -1,6 +1,6 @@
 module ADIWG
     module JsonSchemas
         # Current schema version number
-        VERSION = "0.9.1"
+        VERSION = "0.9.2"
     end
 end

data/schema/schema/citation.json

@@ -154,6 +154,27 @@
           "$ref": "#/definitions/citationBase"
         }
       }
+    },
+    "dictionary": {
+      "type": "object",
+      "required": ["title", "date"],
+      "title": "dictionary citation",
+      "description": "A citation object for data dictionaries.",
+      "properties": {
+        "edition": {
+          "type": "string",
+          "description": "Version identifier for the dictionary.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > edition"],
+            "FGDC CSDGM": ["idinfo > citation > edition"]
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/citationBase"
+        }
+      ]
     }
   }
 }

data/schema/schema/dataDictionary.json

@@ -0,0 +1,189 @@
+{
+  "id": "dataDictionary.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "description": "A catalogue containing definitions and descriptions of the resource types, resource attributes, and resource associations.",
+  "required": ["dictionaryInfo"],
+  "example": "../../examples/full_example.json#/metadata/dataDictionary",
+  "additionalProperties": false,
+  "properties": {
+    "dictionaryInfo": {
+      "type": "object",
+      "description": "Information describing the dictionary and its source.",
+      "required": ["resourceType", "citation", "description"],
+      "additionalProperties": false,
+      "properties": {
+        "citation": {
+          "description": "Citation for the dictionary.",
+          "$ref": "citation.json#/definitions/dictionary"
+        },
+        "resourceType": {
+          "type": "string",
+          "description": "The type of resource described by the dictionary."
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the dictionary."
+        },
+        "language": {
+          "type": "string",
+          "description": "Language used within the dictionary. Should be a valid ISO 639-3 code."
+        }
+      }
+    },
+    "domain": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Information describing an enumerated list of values.",
+        "required": ["domainId", "codeName", "description", "member"],
+        "additionalProperties": false,
+        "properties": {
+          "domainId": {
+            "type": "string"
+          },
+          "commonName": {
+            "type": "string"
+          },
+          "codeName": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "member": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["name", "value", "definition"],
+              "additionalProperties": false,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "value": {
+                  "type": "string"
+                },
+                "definition": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "entity": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["entityId", "codeName", "definition"],
+        "additionalProperties": false,
+        "properties": {
+          "entityId": {
+            "type": "string"
+          },
+          "commonName": {
+            "type": "string"
+          },
+          "codeName": {
+            "type": "string"
+          },
+          "definition": {
+            "type": "string"
+          },
+          "primaryKeyAttributeCodeName": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "index": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["codeName", "allowDuplicates", "attributeCodeName"],
+              "additionalProperties": false,
+              "properties": {
+                "codeName": {
+                  "type": "string"
+                },
+                "allowDuplicates": {
+                  "type": "boolean"
+                },
+                "attributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          },
+          "attribute": {
+            "type": "array",
+            "required": ["codeName", "dataType", "definition", "allowNull"],
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "commonName": {
+                  "type": "string"
+                },
+                "codeName": {
+                  "type": "string"
+                },
+                "definition": {
+                  "type": "string"
+                },
+                "dataType": {
+                  "type": "string"
+                },
+                "allowNull": {
+                  "type": "boolean"
+                },
+                "units": {
+                  "type": "string"
+                },
+                "domainId": {
+                  "type": "string"
+                },
+                "minValue": {
+                  "type": "string"
+                },
+                "maxValue": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "foreignKey": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": ["localAttributeCodeName", "referencedEntityCodeName", "referencedAttributeCodeName"],
+              "additionalProperties": false,
+              "properties": {
+                "localAttributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "referencedEntityCodeName": {
+                  "type": "string"
+                },
+                "referencedAttributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}