Skip to content
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.

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

[BUG]: Wrong Operation Names in Table AASX File Server Interface #352

Open
zrgt opened this issue Dec 5, 2024 · 1 comment
Open

[BUG]: Wrong Operation Names in Table AASX File Server Interface #352

zrgt opened this issue Dec 5, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@zrgt
Copy link

zrgt commented Dec 5, 2024

What happens?

The table AASX File Server Interface contains wrong operation names:

2+|Interface: [[AASX-File-Server]]AASX File Server
h|Operation Name h|Description
e|GetAllAASXPackageIds |Returns a list of available AASX packages at the server
e|GetAASXByPackageId |Returns a specific AASX package from the server
e|PostAASXPackage |Creates an AASX package at the server
--->e|PutAASXByPackageId |Replaces the AASX package at the server
--->e|DeleteAASXByPackageId |Deletes a specific AASX package

Why is this wrong?

In the following chapters Operations with names DeleteAASXPackageById and PutAASXPackageById are defined.

PutAASXByPackageId vs. PutAASXPackageById and DeleteAASXByPackageId vs. DeleteAASXPackageById

How should it be fixed?

  • If DeleteAASXPackageById and PutAASXPackageById are the correct operation names, the table should be updated accordingly.

    • In this case we have not consistent operation names. See: GetAASXByPackageId vs. PutAASXPackageById and we should discuss if the suffix ByPackageId or PackageById should be used.
  • If DeleteAASXByPackageId and PutAASXByPackageId are the correct operation names, the operation names in the corresponding Operation Chapters should be updated.

@zrgt zrgt added bug Something isn't working documentation Improvements or additions to documentation labels Dec 5, 2024
@zrgt
Copy link
Author

zrgt commented Dec 5, 2024

In V3.0.yaml DeleteAASXByPackageId and PutAASXByPackageId are used.
Therefore, the Chapters and Table contents of Operation PutAASXPackageById and Operation DeleteAASXPackageById should be fixed to DeleteAASXByPackageId and PutAASXByPackageId

zrgt added a commit that referenced this issue Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant