[Feature] [SDK] Add documentation regarding the `x-vendor` supported annotations

AmadeusITGroup / otter

The Otter project is a highly modular framework whose goal is to provide a common platform to accelerate and facilitate the development of runtime customizable Angular based Web Applications

https://amadeusitgroup.github.io/otter/

BSD 3-Clause "New" or "Revised" License

51 stars 38 forks source link

[Feature] [SDK] Add documentation regarding the `x-vendor` supported annotations #903

Open kpanot opened 1 year ago

kpanot commented 1 year ago

Context

The main purpose of the SDK's revivers is to revive utils.date (ignoring the timezone browser issue) and to treat the x-vendors to map the dictionary's fields.

This information should be provided to the SDKs users in the documentation relative to the SDK generation

Proposal

[ ] Provide documentation regarding the reviver purpose
[ ] Provide documentation regarding the way to adapt the revivers (core revivers)
[x] (bonus: Provide documentation regarding the utils.date purpose)

mrednic-1A commented 1 year ago

Additionally the @ama-sdk/generator-sdk package readme.md should be updated with the deprecated flag starting from version 9.1, and add a reference to the new package @ama-sdk/schematics.

pginoux-1A commented 12 months ago

@kpanot doesn't this PR https://github.com/AmadeusITGroup/otter/pull/529/files#diff-5aa0ca9700e1c4a904c6a8e16a9e1bb5ec5c6022491ac045cbbb6401bf2f9fc9 cover already a part of this issue ?

kpanot commented 11 months ago

@kpanot doesn't this PR https://github.com/AmadeusITGroup/otter/pull/529/files#diff-5aa0ca9700e1c4a904c6a8e16a9e1bb5ec5c6022491ac045cbbb6401bf2f9fc9 cover already a part of this issue ?

The PR #529 is covering the documentation of the utils.date only.