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

Enhancing Property Requiredness: Introducing a "Recommended" Option #525

Open
Philipp-Liedl opened this issue Feb 13, 2025 · 1 comment
Open

Comments

@Philipp-Liedl
Copy link

Currently, the definition of a property's requiredness is limited to mandatory or optional, using an SMT/Cardinality qualifier: ZeroTo* for optional properties and OneTo* for mandatory ones (see screenshot below).

For larger submodels, such as SM PurchaseOrder, it would be beneficial to introduce an additional qualifier - "recommended" - for optional properties. This would help indicate preferred usage, improving both implementation and adoption with minimal effort for users.

IA preferred solution would be to establish a clear standard, allowing properties to be classified as mandatory, recommended, or optional.

The only alternative currently is to mention "recommended" in the property's description, which is suboptimal as it can be easily overlooked.

Current approach to set the requiredness a property, limited to mandatory (1..) or optional (0..):

Image

@BirgitBoss
Copy link
Collaborator

BirgitBoss commented Feb 14, 2025

Thanks for your finding. Up to now no qualifiers are specified in IDTA-01001. So the first step is to include it in the guideline How to create a submodel template specification

@MichaelHoffmeisterFesto : may you please have a look

@BirgitBoss BirgitBoss added requires workstream approval strategic decision proposal needs to be prepared in TF spec team enhancement New feature or request specification impact on specification and thus on xml, json etc., label "aas-core" not set additinally labels Feb 19, 2025
@BirgitBoss BirgitBoss removed enhancement New feature or request specification impact on specification and thus on xml, json etc., label "aas-core" not set additinally requires workstream approval strategic decision proposal needs to be prepared in TF spec team labels Feb 26, 2025
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

No branches or pull requests

2 participants