Rework Chapter "Value-Only serialization" + editorial changes

admin-shell-io / aas-specs

Repository of the Asset Administration Shell Specification IDTA-01001 - Metamodel

https://industrialdigitaltwin.org/en/content-hub/aasspecifications

Creative Commons Attribution 4.0 International

45 stars 26 forks source link

Rework Chapter "Value-Only serialization" + editorial changes #375

Closed BirgitBoss closed 2 months ago

BirgitBoss commented 3 months ago

Complete rework of chapter "Value-Only" (IDTA-01001_ValueOnly.adoc)

Examples added for $value payloads other than submodel to make it easy to understand after example for payload of element within Submodel or structured element.

Aditionally editorial changes were made w.r.t. linking (xref).

BirgitBoss commented 3 months ago

@mjacoby after discussion in TF API I completely reworked the chapter. Please check again: also your findings should be covered now. Thank you

BirgitBoss commented 3 months ago

The schema needs to be checked against the openAPI specification. @sebbader : can we just include it as is?

The followings bugs as far as I can see:

it needs to be "annotations", not "annoation" and they are not required
Blob/value is not required
EntityValue: statements are not required, entityType is not required any longer
although making sense the metamodel itself does not require Range to be numbers

There are also elements in the schema that are only defined in Part 2, e.g. OperationResultValueOnly

The grammar could be adapted to use the same terms as the schema

BirgitBoss commented 2 months ago

@mjacoby please review again, table was completely revised and rules adapted (and corrected)

mjacoby commented 2 months ago

@BirgitBoss I've responded to the changes/comments

BirgitBoss commented 2 months ago

@BirgitBoss I've responded to the changes/comments

Thanks a lot, I added my responses.

BirgitBoss commented 2 months ago

https://github.com/admin-shell-io/aas-specs/tree/SeBa/part-2-bugfix-changes is already closed. So branch https://github.com/admin-shell-io/aas-specs/tree/BiBo/ValueOnly should be merged in IDTA-01001_working directly.