Skip to content

OceanOPS/oceanjson

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OceanJSON

Integrated GOOS metadata JSON schemas based on the OceanMeta metadata standard.

Goals

Facilitate integration and ensure seamless metadata exchange between nodes.

Entities

The format is broken down into Classes (Mission, Platform, Ship, Cruise, Contact,...) each with their own schema. These are based on the classes, or groups of classes within the OceanMeta ontology. Classes in PascalCase and attributes in camelCase.

Most classes extend a Schema.org schema (eg. Contact extends www.schema.org/Person) These extensions are cited in the context.jsonld file, and attributes imported with the "allOf" attribute within each schema.

The equivalent OceanMeta MCD codes and types are included for each schema and its fields. The keywords oceanMetaCode and oceanMetaType are used for this.

These won't affect validation but provide valuable context, with the following benefits:

  • Traceability: Users can cross-reference these codes with OceanMeta documentation for more details.
  • Documentation Automation: You could auto-generate schema documentation from these codes.
  • Validation Support: Developers can build custom tools to check if data aligns with both JSON Schema and MCD standards.

Examples

In /examples directory, find sample JSON files showing how a complete JSON document would look like.

It will eventually be possible to simply fetch a platform sample array from the OceanOPS API in OceanJSON format:

https://www.ocean-ops.org/api/data/oceanjson/platforms?fields=ref,status

!! WARNING !! THE API DELIVERS A DEPRECATED TEST VERSION OF OceanJSON !

Property Key Naming Standard

Property keys will all be based on the OceanMeta names that should all be identified with their respective code and definition.

The MCD JSON file used to create the Ontology and Dictionary pages in OceanMeta website is here: /docs/oceanmeta-mcd.json

OceanJSON Validator

There will be an online tool where you can test that you JSON is valid OceanJSON.

About

OceanJSON Standard Format definition

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •