Skip to content
Snippets Groups Projects
schema.json 1.38 KiB
Newer Older
Andreas Huber's avatar
Andreas Huber committed
{
Andreas Huber's avatar
Andreas Huber committed
  "type": "object",
Andreas Huber's avatar
Andreas Huber committed
  "title": "Application Schema",
  "description": "Strukturinformationen zu übertragbaren oder übertragenen Daten.",
Andreas Huber's avatar
Andreas Huber committed
  "additionalProperties": false,
  "x-examples": {
    "example-1": {
Andreas Huber's avatar
Andreas Huber committed
      "mimeType": "application/json",
      "schemaSource": "none"
    },
    "example-2": {
Andreas Huber's avatar
Andreas Huber committed
      "mimeType": "application/xml",
      "schemaSource": "none"
    },
    "example-3": {
Andreas Huber's avatar
Andreas Huber committed
      "mimeType": "application/xml",
      "schemaSource": "fim",
      "schemaId": "S99000001V1.0"
    }
  },
  "properties": {
    "schemaId": {
      "type": "string",
      "description": "ID des Schemas, abhängig von der ausgewählten Quelle."
      "type": "string",
      "enum": [
        "fim",
        "none"
      ],
      "description": "Quelle, von der das Schema bezogen werden kann."
    },
    "mimeType": {
      "type": "string",
      "enum": [
Andreas Huber's avatar
Andreas Huber committed
        "application/json",
        "application/xml"
      ],
      "description": "Gibt das zulässige Format (JSON oder XML) der Fachdaten an."
    },
    "encoding": {
      "type": "string",
      "enum": [
        "plain",
        "base64",
        "jwe"
      ],
      "description": "Übertragungscodierung:\n- `plain`: kein Encoding\n- `base64`: Inhalt base64-codieren\n- `jwe`: Inhalt mit JSON Web Encryption verschlüsseln"
  },
  "required": [
    "schemaSource",
Andreas Huber's avatar
Andreas Huber committed
}