Merge branch 'main' into feature/edot

Author: wurzka

.github/workflows/example-not-delted.yml

@@ -19,7 +19,7 @@ jobs:
     - uses: actions/checkout@v4
     - name: Get deleted files
       id: changed-files
-      uses: tj-actions/changed-files@v44
+      uses: step-security/changed-files@v45.0.1
       with:
         files: "file-formats/*/examples/*"
 

.reuse/dep5

@@ -0,0 +1,10 @@
+version = 1
+SPDX-PackageName = "ABAP file formats"
+SPDX-PackageSupplier = "ABAP file formats team <[email protected]>"
+SPDX-PackageDownloadLocation = "https://github.com/SAP/abap-file-formats"
+
+[[annotations]]
+path = "**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2021 SAP SE or an SAP affiliate company and ABAP file formats contributors"
+SPDX-License-Identifier = "MIT"

REUSE.toml

@@ -165,12 +165,13 @@ Normally, if an ABAP object is serialized, only the components of the correspond
 is added. Note that also the `$required` annotation leads to such behavior.
 
 ### Default Values
-To set the `default` for a component of the JSON Schema, the annotation
+To specify the `default` value for a field of the JSON Schema, the annotation
 ```abap
 "! $default
 ```
- is used, followed by the specification of the default. To provide the default, there are two different possibilities:
-1. If the component has enum values, the default value is specified by a link to the corresponding component of the constant describing the enum.
+is used, followed by the specification of the default value.
+To provide the default, there are two different possibilities:
+1. If the field has enum values, the default value is specified by a link to the corresponding component of the constant describing the enum.
 ```abap
 "! $default {@link source_name.data:constant_name.default_component}
 ```
@@ -179,10 +180,23 @@ To set the `default` for a component of the JSON Schema, the annotation
 "! $default 'value'
 ```
 This also ensures that only components whose value is not equal to a specific default value are serialized to the JSON data file.
-Fields, which are not specified in the JSON data file, are deserialized to their default values.
+
+Default values can only be specified if one of the following rules apply:
+
+1. The default value represents the initial value of the underlying data type (e.g., `0` for an integer or `space` for a character field).
+
+2. For enumerations, all other values must **not** represent type initial value of the underlying data type.
+
+3. All higher-level structures* of the field are marked as `$required`.
+
+   > *) Arrays don't need to be marked as `$required` in this case.
+   In JSON it is possible to distinguish between empty arrays (`"table": []`) and arrays with "empty" array items (`"table": [{}]`).
+   All fields with defaults in the array items that don't follow the other rules, along with their higher-level structures, must be marked as `$required`.
+
+Fields that are not specified in the JSON data file are deserialized to their default values.
 Note that if you specify a default value, initial values are written to the JSON data file, unless they are not equal to the selected default.
 
-Since fields, which are not specified in the JSON data, might be represented by either initial values or default values, implementations of serialization and deserialization of ABAP file formats must consider fields with default values as specified here.
+Since fields that are not specified in the JSON data might be represented by either initial values or default values, implementations of serialization and deserialization of ABAP file formats must consider fields with default values, as specified here.
 
 ### Enum Values
 To pass enum values to a JSON Schema, a type and a constant are necessary.

compatibility-check/package-lock.json

@@ -1,4 +1,12 @@
-# ADVC File Format
+# Application Variant File Format
+
+## Object Type Information
+
+Object Type | Description | Group
+:--- | :--- | :---
+ADVC | Application Variant | LRep
+
+## File Structure
 
 File | Cardinality | Definition | Schema | Example
 :--- | :--- | :--- | :--- | :---

docs/json.md

@@ -1,4 +1,12 @@
-# AIFD File Format
+# Deployment Scenario File Format
+
+## Object Type Information
+
+Object Type | Description | Group
+:--- | :--- | :---
+AIFD | Deployment Scenario | Application Interface Framework
+
+## File Structure
 
 File | Cardinality | Definition | Schema | Example
 :--- | :--- | :--- | :--- | :---

file-formats/advc/README.md

@@ -0,0 +1,13 @@
+#  Fix Value File Format
+
+## Object Type Information
+
+Object Type | Description | Group
+:--- | :--- | :---
+AIFF | Fix Value | Application Interface Framework
+
+## File Structure
+
+File | Cardinality | Definition | Schema | Example
+:--- | :--- | :--- | :--- | :---
+`<name>.aiff.json` | 1 | [`zif_aff_aiff_v1.intf.abap`](./type/zif_aff_aiff_v1.intf.abap) | [`aiff-v1.json`](./aiff-v1.json) | [`z_aff_example_aiff.aiff.json`](./examples/z_aff_example_aiff.aiff.json)

file-formats/aifd/README.md

@@ -0,0 +1,94 @@
+{
+  "$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/aiff/aiff-v1.json",
+  "title": "Fix Value",
+  "description": "Fix value",
+  "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": {
+        "namespace": {
+          "title": "Namespace",
+          "description": "Namespace",
+          "type": "string",
+          "maxLength": 15
+        },
+        "aifFixValue": {
+          "title": "AIF Fix Value",
+          "description": "AIF fix value",
+          "type": "string",
+          "maxLength": 20
+        },
+        "fieldValue": {
+          "title": "Field Value",
+          "description": "Field value",
+          "type": "string",
+          "maxLength": 255
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "namespace",
+        "aifFixValue"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "formatVersion",
+    "header",
+    "generalInformation"
+  ]
+}

file-formats/aiff/README.md

@@ -0,0 +1,13 @@
+{
+    "formatVersion": "1",
+    "header": {
+      "description": "Example AIFF for ABAP File Format",
+      "originalLanguage": "en",
+      "abapLanguageVersion": "cloudDevelopment"
+    },
+    "generalInformation":{
+        "namespace": "AIFNS",
+        "aifFixValue": "FixValue1",
+        "fieldValue": "1"
+    }
+  }