Add changes for idShortPath and ValueOnly fixes from part 2 v3.0.2

[sebbader-sap]

Adaptation of adoc should complie to latest valueOnlyand IdShortPath Specification

[BirgitBoss]

Suggested change

	** _SubmodelElementList_ is serialized as a JSON array with $\{SubmodelElementList/idShort} as the name of the containing JSON property the index of the contained SubmodelElement in the list as the position in the JSON array. The elements contained within the list are serialized according to their respective type.
	** _SubmodelElementList_ is serialized as a named JSON array with ${SubmodelElementList/idShort} as the name of the containing JSON property followed by the index in square brackets of the contained SubmodelElement in the list as the position in the JSON array. The elements contained within the list are serialized according to their respective type.

[mjacoby]

Suggested change

** _SubmodelElementList_ is serialized as a JSON array with $\{SubmodelElementList/idShort} as the name of the containing JSON property the index of the contained SubmodelElement in the list as the position in the JSON array. The elements contained within the list are serialized according to their respective type.

** _SubmodelElementList_ is serialized as a named JSON array with $\{SubmodelElementList/idShort} as the name of the containing JSON property. The elements in the JSON array are the ValueOnly serializations of the elements contained in the SubmodelElementList while preserving the order, i.e. index n in the JSON array is the ValueOnly serialization of the element at index n of the SubmodelElementList.

@BirgitBoss
How can the index of a JSON array contain square brackets? That does not make sense.
What exactly are you proposing the resulting JSON looks like? As I understand it, your proposal results in something like this

{
   "{SubmodelElementList/idShort}": {
      "[0]": { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      "[1]: { ... }, // valueOnly serialization of element with index 1
      ...
   }
}

which is not in line with the format described by the PR which is

{
   "{SubmodelElementList/idShort}": [
      { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      { ... }, // valueOnly serialization of element with index 1
      ...
   ]
}

[BirgitBoss]

@BirgitBoss How can the index of a JSON array contain square brackets? That does not make sense. What exactly are you proposing the resulting JSON looks like? As I understand it, your proposal results in something like this

{
   "{SubmodelElementList/idShort}": {
      "[0]": { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      "[1]: { ... }, // valueOnly serialization of element with index 1
      ...
   }
}

which is not in line with the format described by the PR which is

{
   "{SubmodelElementList/idShort}": [
      { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      { ... }, // valueOnly serialization of element with index 1
      ...
   ]
}

I mixed it with the idShortPath representation, you are right.

[BirgitBoss]

Suggested change

Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH

[BirgitBoss]

remove complete sentence

[BirgitBoss]

Suggested change

To get only the idShort paths of a submodel element hierarchy, the serialization format is specified in terms of an idShortPath notation to be returned in an unnamed JSON-array. The notation differs depending on whether a SubmodelElementCollection or a SubmodelElementList is used. In the first case, the submodel element's idShort is separated by "." (dot) from top level down to child level. In the second case, square brackets with an index "[\<<index>>]" are appended after the idShort of the containing SubmodelElementList. In any case, the first item of any idShortPath is the idShort if the requested element.

To get only the idShort paths of a submodel element hierarchy, the serialization format is specified in terms of an idShortPath notation to be returned in an unnamed JSON-array. The notation differs depending on whether a SubmodelElementCollection or a SubmodelElementList is used. In the first case, the submodel element's idShort is separated by "." (dot) from top level down to child level. In the second case, square brackets with an index "[\<<index>>]" are appended after the idShort of the containing SubmodelElementList. In any case, the first item of any idShortPath is the idShort of the requested element.

[BirgitBoss]

Smaller reformulations, typos

[BirgitBoss]

Why target? It is the starting point (relative to this collection)

[BirgitBoss]

In TF API we agreed on terminology "requesting element" (this is the first in the list)

[BirgitBoss]

@mjacoby may youp lease review

[mjacoby]

Suggested change

** _SubmodelElementList_ is serialized as a JSON array with $\{SubmodelElementList/idShort} as the name of the containing JSON property the index of the contained SubmodelElement in the list as the position in the JSON array. The elements contained within the list are serialized according to their respective type.

** _SubmodelElementList_ is serialized as a named JSON array with $\{SubmodelElementList/idShort} as the name of the containing JSON property. The elements in the JSON array are the ValueOnly serializations of the elements contained in the SubmodelElementList while preserving the order, i.e. index n in the JSON array is the ValueOnly serialization of the element at index n of the SubmodelElementList.

@BirgitBoss
How can the index of a JSON array contain square brackets? That does not make sense.
What exactly are you proposing the resulting JSON looks like? As I understand it, your proposal results in something like this

{
   "{SubmodelElementList/idShort}": {
      "[0]": { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      "[1]: { ... }, // valueOnly serialization of element with index 1
      ...
   }
}

which is not in line with the format described by the PR which is

{
   "{SubmodelElementList/idShort}": [
      { ... },  // where {...} is valueOnly serialization of element with index 0, doesn't have to be a JSON object but could also be a prmiitve JSON vlaue such as string or number
      { ... }, // valueOnly serialization of element with index 1
      ...
   ]
}