Merge branch 'main' into feature/saia

SAP · Oct 8, 2024 · 39bc97e · 39bc97e
2 parents 805762f + 8c921e8
commit 39bc97e
Show file tree

Hide file tree

Showing 13 changed files with 275 additions and 12 deletions.
diff --git a/file-formats/aifn/README.md b/file-formats/aifn/README.md
@@ -0,0 +1,5 @@
+# AIFN File Format
+
+File | Cardinality | Definition | Schema | Example
+:--- | :--- | :--- | :--- | :---
+`<name>.aifn.json` | 1 | [`zif_aff_aifn_v1.intf.abap`](./type/zif_aff_aifn_v1.intf.abap) | [`aifn-v1.json`](./aifn-v1.json) | [`z_aff_example_aifn.aifn.json`](./examples/z_aff_example_aifn.aifn.json)
diff --git a/file-formats/aifn/aifn-v1.json b/file-formats/aifn/aifn-v1.json
@@ -0,0 +1,78 @@
+{
+  "$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/aifn/aifn-v1.json",
+  "title": "Namespace",
+  "description": "Namespace",
+  "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": {
+        "aifNamespace": {
+          "title": "AIF Namespace",
+          "description": "AIF namespace",
+          "type": "string",
+          "maxLength": 6
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header",
+    "generalInformation"
+  ]
+}
diff --git a/file-formats/aifn/examples/z_aff_example_aifn.aifn.json b/file-formats/aifn/examples/z_aff_example_aifn.aifn.json
@@ -0,0 +1,11 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "Example AIFN for ABAP File Format",
+    "originalLanguage": "en",
+    "abapLanguageVersion": "cloudDevelopment"
+  },
+  "generalInformation":{
+      "aifNamespace": "/AIFT"
+  }
+}
diff --git a/file-formats/aifn/type/zif_aff_aifn_v1.intf.abap b/file-formats/aifn/type/zif_aff_aifn_v1.intf.abap
@@ -0,0 +1,26 @@
+INTERFACE zif_aff_aifn_v1
+  PUBLIC.
+  TYPES:
+    "! <p class="shorttext">Namespace Details</p>
+    "! Namespace details
+    BEGIN OF ty_general_information,
+      "! <p class="shorttext">AIF Namespace</p>
+      "! AIF namespace
+      aif_namespace TYPE c LENGTH 6,
+    END OF ty_general_information,
+
+    "! <p class="shorttext">Namespace</p>
+    "! Namespace
+    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/aifn/type/zif_aff_aifn_v1.intf.json b/file-formats/aifn/type/zif_aff_aifn_v1.intf.json
@@ -0,0 +1,7 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "AFF type for AIFN (Namespace)",
+    "originalLanguage": "en"
+  }
+}
diff --git a/file-formats/aifr/aifr-v1.json b/file-formats/aifr/aifr-v1.json
@@ -54,9 +54,9 @@
         "originalLanguage"
       ]
     },
-    "recipientDetails": {
-      "title": "Recipient Details",
-      "description": "Recipient details",
+    "generalInformation": {
+      "title": "General Information",
+      "description": "General information",
       "type": "object",
       "properties": {
         "namespace": {
@@ -76,6 +76,6 @@
   "required": [
     "formatVersion",
     "header",
-    "recipientDetails"
+    "generalInformation"
   ]
 }
diff --git a/file-formats/aifr/examples/z_aff_example_aifr.aifr.json b/file-formats/aifr/examples/z_aff_example_aifr.aifr.json
@@ -5,7 +5,7 @@
     "originalLanguage": "en",
     "abapLanguageVersion": "cloudDevelopment"
   },
-  "recipientDetails":{
+  "generalInformation":{
       "namespace": "AIFNS"
   }
 }
diff --git a/file-formats/aifr/type/zif_aff_aifr_v1.intf.abap b/file-formats/aifr/type/zif_aff_aifr_v1.intf.abap
@@ -3,25 +3,25 @@ INTERFACE zif_aff_aifr_v1
   TYPES:
     "! <p class="shorttext">Recipient Details</p>
     "! Recipient details
-    BEGIN OF ty_recipient_details,
+    BEGIN OF ty_general_information,
       "! <p class="shorttext">Namespace</p>
       "! Namespace of the recipient
       "! $required
       namespace TYPE c LENGTH 15,
-    END OF ty_recipient_details,
+    END OF ty_general_information,
 
     "! <p class="shorttext">Recipient</p>
     "! Recipient
     BEGIN OF ty_main,
       "! $required
-      format_version    TYPE zif_aff_types_v1=>ty_format_version,
+      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">Recipient Details</p>
-      "! Recipient details
+      header              TYPE zif_aff_types_v1=>ty_header_60_cloud,
+      "! <p class="shorttext">General Information</p>
+      "! General information
       "! $required
-      recipient_details TYPE ty_recipient_details,
+      general_information TYPE ty_general_information,
     END OF ty_main.
 ENDINTERFACE.
diff --git a/file-formats/desd/README.md b/file-formats/desd/README.md
@@ -0,0 +1,5 @@
+# DESD File Format
+
+File | Cardinality | Definition | Schema | Example
+:--- | :---  | :--- | :--- | :---
+`<name>.desd.json` | 1 | [`zif_aff_desd_v1.intf.abap`](./type/zif_aff_desd_v1.intf.abap) | [`desd-v1.json`](./desd-v1.json) | [`z_aff_example_desd.desd.json`](./examples/z_aff_example_desd.desd.json)
diff --git a/file-formats/desd/desd-v1.json b/file-formats/desd/desd-v1.json
@@ -0,0 +1,82 @@
+{
+  "$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/desd/desd-v1.json",
+  "title": "CDS Logical External Schema",
+  "description": "CDS logical external schema",
+  "type": "object",
+  "properties": {
+    "formatVersion": {
+      "title": "Format Version",
+      "description": "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": {
+        "defaultRemoteSchemaName": {
+          "title": "Default Remote Schema",
+          "description": "Default remote database schema name when configuring the connection details of logical external schema.",
+          "type": "string",
+          "maxLength": 256
+        },
+        "usesRouting": {
+          "title": "Uses Routing",
+          "description": "If true, the logical external schema can only be used in routed scenarios.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header"
+  ]
+}
diff --git a/file-formats/desd/examples/z_aff_example_desd.desd.json b/file-formats/desd/examples/z_aff_example_desd.desd.json
@@ -0,0 +1,7 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "Example DESD for ABAP file format",
+    "originalLanguage": "en"
+  }
+}
diff --git a/file-formats/desd/type/zif_aff_desd_v1.intf.abap b/file-formats/desd/type/zif_aff_desd_v1.intf.abap
@@ -0,0 +1,35 @@
+INTERFACE zif_aff_desd_v1
+  PUBLIC.
+
+  TYPES:
+
+    "! <p class="shorttext">General Information</p>
+    "! General information
+    BEGIN OF ty_general_information,
+      "! <p class="shorttext">Default Remote Schema</p>
+      "! Default remote database schema name when configuring the connection
+      "! details of logical external schema.
+      default_remote_schema_name TYPE c LENGTH 256,
+      "! <p class="shorttext">Uses Routing</p>
+      "! If true, the logical external schema can only be used
+      "! in routed scenarios.
+      uses_routing               TYPE abap_bool,
+    END OF ty_general_information,
+
+    "! <p class="shorttext">CDS Logical External Schema</p>
+    "! CDS logical external schema
+    BEGIN OF ty_main,
+      "! <p class="shorttext">Format Version</p>
+      "! Format version
+      "! $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
+      general_information TYPE ty_general_information,
+    END OF ty_main.
+
+ENDINTERFACE.
diff --git a/file-formats/desd/type/zif_aff_desd_v1.intf.json b/file-formats/desd/type/zif_aff_desd_v1.intf.json
@@ -0,0 +1,7 @@
+{
+  "formatVersion": "1",
+  "header": {
+    "description": "ABAP file format of DESD objects",
+    "originalLanguage": "en"
+  }
+}