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

[Task] Create a clear definition of "Collection Aspect" #312

Open
atextor opened this issue Nov 25, 2024 · 2 comments
Open

[Task] Create a clear definition of "Collection Aspect" #312

atextor opened this issue Nov 25, 2024 · 2 comments
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. task

Comments

@atextor
Copy link
Contributor

atextor commented Nov 25, 2024

Is your task related to a problem? Please describe.
There is a customary concept of "Collection Aspect":

  • In Best Practices it is mentioned: "If there is exactly one Property in an Aspect that has a Collection, List, Set, Sorted Set or Time Series Characteristic (and no other Properties), the Property should be named items."
  • The esmf-sdk generates specific Java classes for Aspects that happen to have exactly one Property with a Set/List/Collection Characteristic

Describe the solution you'd like
Define what a "Collection Aspect" encompasses and what the implications on the JSON payload are.

@aniluede
Copy link
Contributor

aniluede commented Dec 9, 2024

Once the Collection Aspect concept is defined, remove quotation marks from "Collection Aspect" in Best Practices section.

Also, refine definition given there and/or link to the new section created that holds the definition. (With current wording, it is not exactly clear whether a Collection Aspect can only have one Property in total or only one Property with certain Characteristics + there can be other Properties.)

@aniluede
Copy link
Contributor

aniluede commented Dec 9, 2024

For the part mentioned above – "The esmf-sdk generates specific Java classes for Aspects that happen to have exactly one Property with a Set/List/Collection Characteristic" –, create documentation where this is mentioned/explained.

Then link to this documentation from the "Collection Aspect" chapter in the Best Practices section. (Currently the section does not provide a reason for the naming advice that gets promoted there as a best practice. Therefore, provide this reason and link out to further details in the ESMF SDK docs once this has been created through this very task here.)

@chris-volk chris-volk added the acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. label Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledged Has been viewed by one of the maintainers and is ready for further work, discussion or other steps. task
Projects
None yet
Development

No branches or pull requests

3 participants