diff --git a/file-formats/desd/README.md b/file-formats/desd/README.md new file mode 100644 index 000000000..952a83f6d --- /dev/null +++ b/file-formats/desd/README.md @@ -0,0 +1,5 @@ +# DESD File Format + +File | Cardinality | Definition | Schema | Example +:--- | :--- | :--- | :--- | :--- +`.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 new file mode 100644 index 000000000..dd6a3dccb --- /dev/null +++ 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 new file mode 100644 index 000000000..e4957ed43 --- /dev/null +++ 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 new file mode 100644 index 000000000..192071b71 --- /dev/null +++ b/file-formats/desd/type/zif_aff_desd_v1.intf.abap @@ -0,0 +1,35 @@ +INTERFACE zif_aff_desd_v1 + PUBLIC. + + TYPES: + + "!

General Information

+ "! General information + BEGIN OF ty_general_information, + "!

Default Remote Schema

+ "! Default remote database schema name when configuring the connection + "! details of logical external schema. + default_remote_schema_name TYPE c LENGTH 256, + "!

Uses Routing

+ "! If true, the logical external schema can only be used + "! in routed scenarios. + uses_routing TYPE abap_bool, + END OF ty_general_information, + + "!

CDS Logical External Schema

+ "! CDS logical external schema + BEGIN OF ty_main, + "!

Format Version

+ "! Format version + "! $required + format_version TYPE zif_aff_types_v1=>ty_format_version, + "!

Header

+ "! Header + "! $required + header TYPE zif_aff_types_v1=>ty_header_60_cloud, + "!

General Information

+ "! 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 new file mode 100644 index 000000000..f6b8faa2a --- /dev/null +++ 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" + } +}