@poseidat/schemas/lib/schema/core/vessel-section.json

The core schemas for the PoseiDAT data interchange formats

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://poseidat.org/schema/core/vessel-section.json",
  "description": "A section off a vessel, used to detail where objects are on the vessel",
  "title": "Vessel section",
  "properties": {
    "vessel_section_id": {
      "description": "The unique identifier for the section (UUID v4)",
      "type": "string",
      "format": "uuid"
    },
    "compartment": {
      "description": "The compartment this section is in",
      "$ref": "https://poseidat.org/schema/enum/vessel-compartment.json"
    },
    "name": {
      "description": "The name of this section",
      "type": "string"
    },
    "description": {
      "description": "The description of this section in the compartment",
      "type": "string"
    },
    "pos_x": {
      "description": "The x position in cm, the position which is closest to the port side is 0cm",
      "type": "number"
    },
    "pos_y": {
      "description": "The y position in cm, the position which is closest to the stern is 0cm",
      "type": "number"
    },
    "pos_z": {
      "description": "The z position in cm, the position which is closest to the keel is 0cm",
      "type": "number"
    }
  },
  "type": "object",
  "required": [
    "vessel_section_id",
    "compartment"
  ]
}