SAP / abap-file-formats-tools

Tools for the development of ABAP file formats
MIT License
25 stars 6 forks source link

Documentation for content media type and content encoding #234

Closed wurzka closed 1 year ago

wurzka commented 1 year ago

With #231, we added annotations for content media type and content encoding. This pull request adds the corresponding documentation.

larshp commented 1 year ago

but well, this is not a feature for ABAP file formats, right?

wurzka commented 1 year ago

Yes, this should not be used for AFF. Hence, we wanted to document it here instead of the AFF-repo

schneidermic0 commented 1 year ago

but well, this is not a feature for ABAP file formats, right?

Any suggestions where we should document the behavior of the generator? As @wurzka wrote. Since it is not a feature of AFF, we moved the documentation to this repository.

larshp commented 1 year ago

I think the content-type feature would typically be needed in a REST setup, which is already covered else-ware. But I dont know, since I dont know the use-case

I suggest keeping the feature list as small as possible, as it will keep everything working

schneidermic0 commented 1 year ago

I suggest keeping the feature list as small as possible, as it will keep everything working

We wouldn't add if it was not needed. ;) It's really about transferring non-JSON data within a JSON document. See also https://json-schema.org/understanding-json-schema/reference/non_json_data.html

As mentioned before it is not related to the ABAP-file-formats. However, forking the tooling just for this use case seem also a bit over-engineered, isn't it?

larshp commented 1 year ago

true

but if you choose to share the use-case, then it will be possible to share alternative solutions

schneidermic0 commented 1 year ago

but if you choose to share the use-case, then it will be possible to share alternative solutions

I need to check whether I can already share it.

wurzka commented 1 year ago

Thanks @albertmink !

schneidermic0 commented 1 year ago

@wurzk, @larshp and I have just decided in a call to merge the changes for now.