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

Example spacecmd usage for API calls that require Arguments #3296

Open
cudafly opened this issue Aug 29, 2024 · 0 comments
Open

Example spacecmd usage for API calls that require Arguments #3296

cudafly opened this issue Aug 29, 2024 · 0 comments
Labels
docs backlog In the docs backlog

Comments

@cudafly
Copy link

cudafly commented Aug 29, 2024

There are no real world examples on how to call API methods via spacecmd, and methods that take arguments are also not explained.

https://documentation.suse.com/suma/4.3/en/suse-manager/reference/spacecmd/api.html

Documentation Update Required

Provide examples of using the "spacecmd api" function. A couple examples are below:

Standard GET method with no arguments
spacecmd api channel.listAllChannels

Example of POST method that requires arguments, only works if "--" are included
spacecmd -- api channel.access.enableUserRestrictions -A "$channelLabel"

What does the documentation say now?

Very basic no example at all. No mention of needed "--" so the api can take in the arguments.

@keichwa keichwa added the docs backlog In the docs backlog label Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs backlog In the docs backlog
Projects
None yet
Development

No branches or pull requests

2 participants