[EVTO] Add new object type EVTO (#675)

Co-authored-by: Katharina Wurz <katharina.wurz@sap.com>
SAP · Dec 5, 2024 · 4172a15 · 4172a15
1 parent 42bed29
commit 4172a15
Show file tree

Hide file tree

Showing 5 changed files with 179 additions and 0 deletions.
diff --git a/file-formats/evto/README.md b/file-formats/evto/README.md
@@ -0,0 +1,5 @@
+# EVTO File Format
+
+File | Cardinality | Definition | Schema | Example
+:--- | :--- | :--- | :--- | :---
+`<name>.evto.json` | 1 | [`zif_aff_evto_v1.intf.abap`](./type/zif_aff_evto_v1.intf.abap) | [`evto-v1.json`](./evto-v1.json) | [`z_aff_example.evto.json`](./examples/z_aff_example.evto.json)
diff --git a/file-formats/evto/evto-v1.json b/file-formats/evto/evto-v1.json
@@ -0,0 +1,105 @@
+{
+  "$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information.",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/SAP/abap-file-formats/blob/main/file-formats/evto/evto-v1.json",
+  "title": "Event Object",
+  "description": "Event Object",
+  "type": "object",
+  "properties": {
+    "formatVersion": {
+      "title": "ABAP File Format Version",
+      "description": "The ABAP file format version",
+      "type": "string",
+      "const": "1"
+    },
+    "header": {
+      "title": "Header",
+      "description": "Header",
+      "type": "object",
+      "properties": {
+        "description": {
+          "title": "Description",
+          "description": "Description of the ABAP object",
+          "type": "string",
+          "maxLength": 60
+        },
+        "originalLanguage": {
+          "title": "Original Language",
+          "description": "Original language of the ABAP object",
+          "type": "string",
+          "minLength": 2
+        },
+        "abapLanguageVersion": {
+          "title": "ABAP Language Version",
+          "description": "ABAP language version",
+          "type": "string",
+          "enum": [
+            "standard",
+            "cloudDevelopment"
+          ],
+          "enumTitles": [
+            "Standard",
+            "ABAP Cloud Development"
+          ],
+          "enumDescriptions": [
+            "Standard",
+            "ABAP cloud development"
+          ],
+          "default": "standard"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "description",
+        "originalLanguage"
+      ]
+    },
+    "generalInformation": {
+      "title": "General Information",
+      "description": "General information",
+      "type": "object",
+      "properties": {
+        "sapObjectType": {
+          "title": "SAP Object Type",
+          "description": "SAP Object Type",
+          "type": "string",
+          "maxLength": 30
+        },
+        "majorVersion": {
+          "title": "Major Version",
+          "description": "Major version",
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 2147483647
+        },
+        "minorVersion": {
+          "title": "Minor Version",
+          "description": "Minor version",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 2147483647
+        },
+        "patchVersion": {
+          "title": "Patch Version",
+          "description": "Patch version",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 2147483647
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sapObjectType",
+        "majorVersion",
+        "minorVersion",
+        "patchVersion"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header",
+    "generalInformation"
+  ]
+}
diff --git a/file-formats/evto/examples/z_aff_example.evto.json b/file-formats/evto/examples/z_aff_example.evto.json
@@ -0,0 +1,13 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "Example Event Object.",
+    "originalLanguage": "en"
+  },
+  "generalInformation": {
+    "sapObjectType": "Z_AFF_EXAMPLE",
+    "majorVersion": 1,
+    "minorVersion": 0,
+    "patchVersion": 4
+  }
+}
diff --git a/file-formats/evto/type/zif_aff_evto_v1.intf.abap b/file-formats/evto/type/zif_aff_evto_v1.intf.abap
@@ -0,0 +1,49 @@
+INTERFACE zif_aff_evto_v1
+  PUBLIC.
+
+  TYPES:
+    "! <p class="shorttext">General Information</p>
+    "! General information
+    BEGIN OF ty_general_information,
+      "! <p class="shorttext">SAP Object Type</p>
+      "! SAP Object Type
+      "! $required
+      sap_object_type TYPE c LENGTH 30,
+
+      "! <p class="shorttext">Major Version</p>
+      "! Major version
+      "! $minimum 1
+      "! $required
+      major_version   TYPE i,
+
+      "! <p class="shorttext">Minor Version</p>
+      "! Minor version
+      "! $minimum 0
+      "! $required
+      minor_version   TYPE i,
+
+      "! <p class="shorttext">Patch Version</p>
+      "! Patch version
+      "! $minimum 0
+      "! $required
+      patch_version   TYPE i,
+    END OF ty_general_information.
+
+  TYPES:
+    "! <p class="shorttext">Event Object</p>
+    "! Event Object
+    BEGIN OF ty_main,
+      "! $required
+      format_version      TYPE zif_aff_types_v1=>ty_format_version,
+
+      "! <p class="shorttext">Header</p>
+      "! Header
+      "! $required
+      header              TYPE zif_aff_types_v1=>ty_header_60_cloud,
+
+      "! <p class="shorttext">General Information</p>
+      "! General information
+      "! $required
+      general_information TYPE ty_general_information,
+    END OF ty_main.
+ENDINTERFACE.
diff --git a/file-formats/evto/type/zif_aff_evto_v1.intf.json b/file-formats/evto/type/zif_aff_evto_v1.intf.json
@@ -0,0 +1,7 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "RAP EEE: Event Object AFF Type Interface",
+    "originalLanguage": "en"
+  }
+}