OceanOPS / oceanops-json-standard

OceanJSON Standard Format definition
2 stars 0 forks source link

OceanJSON

An integrated GOOS metadata JSON standard format.

Goals

Facilitate integration and ensure seamless metadata exchange between nodes.

Entities

The format is broken down into Key Entities (Platform, Ship, Cruise, Contact, Site, Observation, Telecom, Status, Agency, ..) each with their own schema.

Validation

JSON Schema files for each key entity in /schemas directory.

Examples

Sample JSON files showing how a complete JSON document would look when adhering to your format in /examples directory.

Property Key Case

We have adopted the snake_case convention for all property keys within our JSON format.

This approach ensures consistency, readability, and alignment with common JSON practices.

The key characteristics of this naming convention are:

Property Key Naming Standard

In almost all cases, we avoid prefixing the name of the entity in the property key.

For instance here, we name the property key 'country' - not 'deployment_country' or 'platform_deployment_country'

And we name the property key 'name' - not 'country_name' or 'platform_deployment_country_name'

"deployment": {
    "method": {},
    "country": {
        "code3": "DEU",
        "code2": "DE",
        "name": "Germany",
        "id": 164
    }
}