Skip to content

Inconsistency in AAS Specification: ReferenceValue valueOnly serialization loses referredSemanticId in OpenAPI Spec #521

@FriedJannik

Description

@FriedJannik

What happens?

According to IDTA-01001 v3.1.1, ReferenceElement in valueOnly JSON serialization is serialized as
{ idShort: Reference }, where the Reference itself is serialized in Normal format.
In the OpenAPI Specification however, the ReferenceValue Element is used as value for ReferenceElementValue which is missing the referredSemanticId field

Why is this wrong?

  • The specification explicitly states that the Reference in valueOnly serialization must use Normal serialization.
  • In Normal serialization, referredSemanticId is a valid and relevant part of a Reference.
  • Omitting referredSemanticId leads to a loss of semantic information.
  • The serialized representation cannot be fully reconstructed (no round-tripping).
  • This creates an inconsistency between the written specification and the OpenAPI definition.

How should it be fixed?

One of the following changes could be applied:

  • Add referredSemanticId as an optional field to ReferenceValue in the OpenAPI specification.

  • Or, Clarify the specification text to explicitly state that referredSemanticId is optional or may be omitted in valueOnly serialization.

  • Or, Change the specification text that the Reference Value in the 'Value' Format should be used

  • I have signed the required Developer Certificate of Origin (DCO) already.

Metadata

Metadata

Assignees

Labels

acceptedbugSomething isn't working

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions