diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc index 658cfb6e..c2fa4019 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc @@ -37,6 +37,7 @@ Major Changes: * new: Added 'Role' and 'NotApplicable' wherever AssetAdministrationShellDescriptor/AssetKind is used. * change: Added minLength=1 requirement and regex pattern "^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$" to all classes with idShort parameters to keep definitions in sync with the declaration of link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/common.html#referable-attributes[Referable/idShort] * change: Fix missing 'Repository' in ConceptDescriptionServiceSpecification to ConceptDescriptionRepositoryServiceSpecification (https://github.com/admin-shell-io/aas-specs-api/issues/171[#171]) +* new: Add classes xref:specification/interfaces-payload.adoc#operation-request-value-only[OperationRequestValueOnly] and xref:specification/interfaces-payload.adoc#operation-result-value-only[OperationResultValueOnly] explicitly (https://github.com/admin-shell-io/aas-specs-api/issues/269[#269]) * change: Additional clarifications on the implicit support of xref:http-rest-api/service-specifications-and-profiles.adoc#service-specifications-and-profiles[major and minor versions of service specifications] (https://github.com/admin-shell-io/aas-specs-api/issues/264[264]) Minor Changes: diff --git a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc index 3815120d..76309224 100644 --- a/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc +++ b/documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc @@ -678,6 +678,24 @@ h|Attribute h|Explanation h|Type h|Card. |clientTimeoutDuration a|Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion. |duration |0..1 |=== +[#operation-request-value-only] +===== OperationRequestValueOnly + +[.table-with-appendix-table] +[cols="25%,40%,25%,10%"] +|=== +h|Class Name 3+e|[[OperationRequestValueOnly]]OperationRequestValueOnly +h|Explanation 3+a|The operation request object +h|Inherits from 3+|-- +h|semanticId* 3+|`\https://admin-shell.io/aas/API/DataTypes/OperationRequestValueOnly/3/1` + +h|Attribute h|Explanation h|Type h|Card. + +|inputArguments a|Input argument | link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html#json-schema-value-only[SubmodelElementValue] |0..* +|inoutputArguments a|InOutput argument |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html#json-schema-value-only[SubmodelElementValue] |0..* +|clientTimeoutDuration a|Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion. |duration |0..1 +|=== + ===== BaseOperationResult [.table-with-appendix-table] @@ -708,6 +726,23 @@ e|outputArguments |Output argument |link:https://admin-shell-io.github.io/aas-sp e|inoutputArguments |InOutput argument |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/spec-metamodel/submodel-elements.html#OperationVariable[OperationVariable] |0..* |=== + +[#operation-result-value-only] +===== OperationResultValueOnly + +[.table-with-appendix-table] +[cols="25%,40%,25%,10%"] +|=== +h|Class Name 3+e|[[OperationResultValueOnly]]OperationResultValueOnly +h|Explanation 3+a|The operation’s invocation result object in the ValueOnly notation. +h|Inherits from 3+|BaseOperationResult +h|semanticId 3+|`\https://admin-shell.io/aas/API/DataTypes/OperationResultValueOnly/3/1` + +h|Attribute h|Explanation h|Type h|Card. +e|outputArguments |Output argument |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html#json-schema-value-only[SubmodelElementValue] |0..* +e|inoutputArguments |InOutput argument |link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html#json-schema-value-only[SubmodelElementValue] |0..* +|=== + ===== Enumeration ExecutionState [.table-with-appendix-table]