Skip to content

Add OperationResultValueOnly and OperationRequestValueOnly Classes #440

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 23, 2025
Merged

Add OperationResultValueOnly and OperationRequestValueOnly Classes #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e4dfa8
add OperationResultValueOnly and OperationRequestValueOnly classes
sebbader-sap Apr 20, 2025
1fdf1cc
OperationResultValueOnly inherits from BaseOperationResult & using Su…
sebbader-sap Apr 22, 2025
10f0c92
Merge branch 'IDTA-01002-3-1_preparation' into SeBa/269-schemas-for-p…
sebbader-sap Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
35 changes: 35 additions & 0 deletions ...mentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,24 @@
|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]
Expand Down Expand Up @@ -708,6 +726,23 @@
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..*

Check warning on line 743 in documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'inoutput'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'inoutput'
|===

===== Enumeration ExecutionState

[.table-with-appendix-table]
Expand Down