CodeDescriptionsV1

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/digitraffic-fi/json-schema/digitraffic-fi-code-descriptions-v1-schema.json",
  "title": "CodeDescriptionsV1",
  "description": "Code descriptions associated with port calls",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/digitraffic-fi-port-call-v1-api-openapi.yml#/components/schemas/CodeDescriptionsV1",
  "required": [
    "agentTypes",
    "cargoTypes",
    "dataUpdatedTime",
    "vesselTypes"
  ],
  "type": "object",
  "properties": {
    "dataUpdatedTime": {
      "type": "string",
      "description": "Timestamp when metadata were last updated",
      "format": "date-time"
    },
    "cargoTypes": {
      "type": "array",
      "description": "All cargo type descriptions",
      "items": {
        "$ref": "#/$defs/CodeDescriptionJsonV1"
      }
    },
    "vesselTypes": {
      "type": "array",
      "description": "All vessel type descriptions",
      "items": {
        "$ref": "#/$defs/CodeDescriptionJsonV1"
      }
    },
    "agentTypes": {
      "type": "array",
      "description": "All agent type descriptions",
      "items": {
        "$ref": "#/$defs/CodeDescriptionJsonV1"
      }
    }
  },
  "$defs": {
    "CodeDescriptionJsonV1": {
      "required": [
        "code",
        "descriptionEn",
        "descriptionFi"
      ],
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Code"
        },
        "descriptionFi": {
          "type": "string",
          "description": "Description of the code(Finnish)"
        },
        "descriptionEn": {
          "type": "string",
          "description": "Description of the code(English)"
        }
      },
      "description": "Description of code"
    }
  }
}