Skip to content

Async AASX File Server Profile#531

Open
sebbader-sap wants to merge 4 commits intoIDTA-01002-3-2_workingfrom
SeBa/347-async-aasx
Open

Async AASX File Server Profile#531
sebbader-sap wants to merge 4 commits intoIDTA-01002-3-2_workingfrom
SeBa/347-async-aasx

Conversation

@sebbader-sap
Copy link
Contributor

@sebbader-sap sebbader-sap commented Feb 7, 2026

Closes #347

@CLAassistant
Copy link

CLAassistant commented Feb 7, 2026 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 7, 2026
View reviewed changes
documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc

Major Changes:

* Add the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'AASX'
documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
h|Operation h|Kind of Change h|Comment
| GenerateSerializationByIds|change a| Added a note to clarify the intended behavior for transitively referenced concept descriptions. (https://github.com/admin-shell-io/aas-specs-api/issues/510[#510])
| PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506])
| PostAsyncAASXPackage|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'AASX'
documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
| GenerateSerializationByIds|change a| Added a note to clarify the intended behavior for transitively referenced concept descriptions. (https://github.com/admin-shell-io/aas-specs-api/issues/510[#510])
| PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506])
| PostAsyncAASXPackage|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])
| GetAasxAsyncStatus|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'Aasx'
documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
| PutAssetAdministrationShellById|change a| Added the missing `id` input parameter and a note explaining the behavior in case the AAS identifier does not match the value of `id`. (https://github.com/admin-shell-io/aas-specs-api/issues/506[#506])
| PostAsyncAASXPackage|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])
| GetAasxAsyncStatus|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])
| GetAasxAsyncResult|new a| New API Operation for the asynchronous AASX File Server Service Specification (https://github.com/admin-shell-io/aas-specs-api/issues/347[#347])

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'Aasx'
documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc



==== Operation GetAasxAsyncResult

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'Aasx'
documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc
[.table-with-appendix-table]
[width=100%,cols="25%,35%,10%,20%,10%"]
|===
h|Operation Name 4+e|[[GetAasxAsyncResult]]GetAasxAsyncResult

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'Aasx'
@g1zzm0
Copy link
Contributor

g1zzm0 commented Feb 12, 2026

@Rudra-sandeep can you please sign the CLA

g1zzm0
g1zzm0 approved these changes Feb 12, 2026
View reviewed changes
Copy link
Contributor

@g1zzm0 g1zzm0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked change of 3.1 version to 3.2 in semanticIds
Checked remaing files 3.1 to 3.2
Checked no 3.1 in 3.1 files
Checked no 3.2 in 3.2 files

@sebbader-sap sebbader-sap marked this pull request as ready for review February 13, 2026 15:47
@aaronzi
Copy link
Member

aaronzi commented Feb 14, 2026

  1. Version bumps to 3.2 look good. Can confirm that nothing was missed.
  2. The new async profile for the AASX File Server is consistent with SSP-01 of the AASX File Server and async Operation invokation.

I just wonder about two preexisting "problems":

  • Why are description endpoints different when looking at the components? Some include more error responses than others
  • Why is the handleId not explicitly mentioned in the 202 status so that clients know what to expect when calling those status endpoints?

github-advanced-security[bot]
github-advanced-security bot found potential problems Feb 27, 2026
View reviewed changes
documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc
|PutAASXByPackageId |PUT |/packages/\{packageId} |base64url-encoded identifier
|DeleteAASXByPackageId |DELETE |/packages/\{packageId} |base64url-encoded identifier
|PostAsyncAASXPackage |POST |/packages-async |
|GetAasxAsyncStatus |GET |/packages-async/\{handleId} |

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'Aasx'
documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc
[plantuml, aasx-upload-invocation, svg]
....include::partial$diagrams/aasx-upload-invocation.puml[]
....
The client sends a POST request to the "/packages-async" endpoint with the AASX file in the request body.

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'AASX'
@sebbader-sap sebbader-sap changed the base branch from main to IDTA-01002-3-2_working February 27, 2026 16:40
@sebbader-sap
Copy link
Contributor Author

sebbader-sap commented Feb 27, 2026

Why is the handleId not explicitly mentioned in the 202 status so that clients know what to expect when calling those status endpoints?

@aaronzi That's a very valid point. I need to think about how we made this with the SME Operation invocations...

@sebbader-sap sebbader-sap added this to the 3.2 milestone Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@g1zzm0 g1zzm0 g1zzm0 approved these changes

@aaronzi aaronzi aaronzi approved these changes

@BirgitBoss BirgitBoss Awaiting requested review from BirgitBoss BirgitBoss is a code owner

@aorzelskiGH aorzelskiGH Awaiting requested review from aorzelskiGH aorzelskiGH is a code owner

@alexgordtop alexgordtop Awaiting requested review from alexgordtop alexgordtop is a code owner

@mjacoby mjacoby Awaiting requested review from mjacoby mjacoby is a code owner

@danielporta danielporta Awaiting requested review from danielporta danielporta is a code owner

@waltersve waltersve Awaiting requested review from waltersve waltersve is a code owner

@zrgt zrgt Awaiting requested review from zrgt zrgt is a code owner

@whamm86 whamm86 Awaiting requested review from whamm86

@mdanish98 mdanish98 Awaiting requested review from mdanish98

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.2

Development

Successfully merging this pull request may close these issues.

AASX File Server: Async. API for transferring larger files

4 participants

@sebbader-sap @CLAassistant @g1zzm0 @aaronzi