Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDOI] Add new object types EDOI #681

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

i506210
Copy link

@i506210 i506210 commented Jan 27, 2025

No description provided.

Copy link

cla-assistant bot commented Jan 27, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

cla-assistant bot commented Jan 27, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@schneidermic0
Copy link
Contributor

Hi @i506210,

Thank you for your contribution.

Would you mind to split this pull request (PR) into two PRs? One for EDOI and one for EDOT. I believe the handling for one PR per object type will be easier.

Furthermore, you might want to remove the .DS_Store files from the PR.

Thanks :)

@i506210 i506210 changed the title [EDOI][EDOT] Add new object types EDOI and EDOT [EDOI] Add new object types EDOI Jan 28, 2025
@i506210
Copy link
Author

i506210 commented Jan 28, 2025

Hi @i506210,

Thank you for your contribution.

Would you mind to split this pull request (PR) into two PRs? One for EDOI and one for EDOT. I believe the handling for one PR per object type will be easier.

Furthermore, you might want to remove the .DS_Store files from the PR.

Thanks :)

Hi @schneidermic0,

I have split Pull request into 2 and triggered PR. could you please check

Thanks & REgards,
Venkat

Copy link
Member

@Markus1812 Markus1812 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Venkat,

thanks for the update. I've added some questions/comments to your pull request.

Please note, that for the title and description, we use title case and sentence case respectively. I've not marked every occurrence but if you could please adjust that.

"! <p class="shorttext">Interface Version</p>    "<- title (title case)
"! Interface version                             "<- description (sentence case)

Comment on lines 67 to 74
"! <p class="shorttext">eDocument Interface</p>
"! eDocument Interface
"! $required
edocument_interface_id TYPE c LENGTH 30,
"! <p class="shorttext">eDocument Interface Description</p>
"! Interface Description.
"! $required
interface_description TYPE c LENGTH 100,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this edocument_interface_id and interface_description the name and description of this EDOI object?

To prevent redundant data, the name is saved in the file name, and the description is saved in ty_main->header (where you currently have selected a header with description length 60, but there is also a version for length 80 or length 100 available).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be I might have added 'header' by referring the sample interface. I don't know the purpose of 'header' section. If its not necessary, i will remove it.
Could you please explain the statement "the name is saved in the file name,", As I didn't find the field 'file name'.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be I might have added 'header' by referring the sample interface. I don't know the purpose of 'header' section. If its not necessary, i will remove it.

We expect formatVersionand header as mandatory fields. See https://github.com/SAP/abap-file-formats/blob/main/docs/json.md#writing-json-schema-with-abap-types

Therefore, please do not remove it ;)

Could you please explain the statement "the name is saved in the file name,", As I didn't find the field 'file name'.

If you check the file names in AFF, the object name is stored there. There is no need to add it to the file content. This would be redundant data.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected, removed object name and description from general information

file-formats/edoi/type/zif_aff_edoi_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/edoi/type/zif_aff_edoi_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/edoi/type/zif_aff_edoi_v1.intf.abap Outdated Show resolved Hide resolved
@i506210
Copy link
Author

i506210 commented Jan 28, 2025

Hi Venkat,

thanks for the update. I've added some questions/comments to your pull request.

Please note, that for the title and description, we use title case and sentence case respectively. I've not marked every occurrence but if you could please adjust that.

"! <p class="shorttext">Interface Version</p>    "<- title (title case)
"! Interface version                             "<- description (sentence case)

Hi

Hi Venkat,

thanks for the update. I've added some questions/comments to your pull request.

Please note, that for the title and description, we use title case and sentence case respectively. I've not marked every occurrence but if you could please adjust that.

"! <p class="shorttext">Interface Version</p>    "<- title (title case)
"! Interface version                             "<- description (sentence case)

Hi Michael,

I corrected all the places.

Thanks & Regards,
Venkat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants