Skip to content

Finished API implementation and Base for CLI-Tool#52

Merged
flowolf merged 24 commits intosmaxtec:mainfrom
Mopsgeschwindigkeit:main
Nov 23, 2025
Merged

Finished API implementation and Base for CLI-Tool#52
flowolf merged 24 commits intosmaxtec:mainfrom
Mopsgeschwindigkeit:main

Conversation

@Mopsgeschwindigkeit
Copy link
Contributor

@Mopsgeschwindigkeit Mopsgeschwindigkeit commented May 13, 2024

Summary

This PR should be seen as a good base for further development. All Implemented features a working and are fully test (90% test coverage).

This PR introduces a complete redesign of the CLI and a complete implementation of the public API's. (more information below).

For the foreseeable future I will stop working on this project, because of:

  • Future of the public API not sure
  • Company support is very little (which is completely understandable!)
  • Currently I do not see someone using it.

API

This PR contains the complete implementation of every public API Endpoint provided via PublicAPIv2 and IntegrationAPIV2. Located in sxapi/src/<publicV2|integrationV2>

CLI

It also contains a basis for further CLI Tool implementations. Can be found under sxapi/src/cli.
There already some example Implementations for the CLI -> the animals, abort and token parser.

I did did full rebuild of the CLI design, thats why the approach is completely different from previous one.
The CLI now follows a kubectl style design, like

  • sxapi animals get --ids <id1> <id2>
  • sxapi aborts delete <animal_id> <abort_id>
  • ...

better error message for SxapiAuthorizationError
raise custom errors instead of return an integer != 0
fix failing test from resulting raises
@Mopsgeschwindigkeit
Copy link
Contributor Author

@flowolf updated the changed we talked about

Copy link
Contributor

@flowolf flowolf left a comment

Choose a reason for hiding this comment

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

thanks for the update. some small changes might be required

@flowolf flowolf merged commit 089415d into smaxtec:main Nov 23, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants