[MM-63555] mmctl: Add compliance export show and cancel cmds (#30569)
* add compliance export cancel command and tests - Introduced `ComplianceExportCancelCmd` to allow cancellation of compliance export jobs. - Implemented unit tests for the cancellation command, covering successful cancellation, error handling for non-existent jobs, and cancellation in non-cancellable states. - Added end-to-end tests to validate the command's functionality in the E2E test suite. * mmctl docs * clean up example text; remove unneeded getJob * fix tests * fix tests, again. * prefer hyphen for command naming * update docs
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
9399398e04
Коммит
e60f878090
@@ -35,7 +35,7 @@ SEE ALSO
|
||||
* `mmctl channel <mmctl_channel.rst>`_ - Management of channels
|
||||
* `mmctl command <mmctl_command.rst>`_ - Management of slash commands
|
||||
* `mmctl completion <mmctl_completion.rst>`_ - Generates autocompletion scripts for bash and zsh
|
||||
* `mmctl compliance_export <mmctl_compliance_export.rst>`_ - Management of compliance exports
|
||||
* `mmctl compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
* `mmctl config <mmctl_config.rst>`_ - Configuration
|
||||
* `mmctl docs <mmctl_docs.rst>`_ - Generates mmctl documentation
|
||||
* `mmctl export <mmctl_export.rst>`_ - Management of exports
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _mmctl_compliance_export:
|
||||
.. _mmctl_compliance-export:
|
||||
|
||||
mmctl compliance_export
|
||||
mmctl compliance-export
|
||||
-----------------------
|
||||
|
||||
Management of compliance exports
|
||||
@@ -16,7 +16,7 @@ Options
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for compliance_export
|
||||
-h, --help help for compliance-export
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -37,6 +37,7 @@ SEE ALSO
|
||||
~~~~~~~~
|
||||
|
||||
* `mmctl <mmctl.rst>`_ - Remote client for the Open Source, self-hosted Slack-alternative
|
||||
* `mmctl compliance_export list <mmctl_compliance_export_list.rst>`_ - List compliance export jobs, sorted by creation date descending (newest first)
|
||||
* `mmctl compliance_export show <mmctl_compliance_export_show.rst>`_ - Show compliance export job
|
||||
* `mmctl compliance-export cancel <mmctl_compliance-export_cancel.rst>`_ - Cancel compliance export job
|
||||
* `mmctl compliance-export list <mmctl_compliance-export_list.rst>`_ - List compliance export jobs, sorted by creation date descending (newest first)
|
||||
* `mmctl compliance-export show <mmctl_compliance-export_show.rst>`_ - Show compliance export job
|
||||
|
||||
51
server/cmd/mmctl/docs/mmctl_compliance-export_cancel.rst
Обычный файл
51
server/cmd/mmctl/docs/mmctl_compliance-export_cancel.rst
Обычный файл
@@ -0,0 +1,51 @@
|
||||
.. _mmctl_compliance-export_cancel:
|
||||
|
||||
mmctl compliance-export cancel
|
||||
------------------------------
|
||||
|
||||
Cancel compliance export job
|
||||
|
||||
Synopsis
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
Cancel compliance export job
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance-export cancel [complianceExportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance-export cancel o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
-h, --help help for cancel
|
||||
|
||||
Options inherited from parent commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
--config string path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
|
||||
--disable-pager disables paged output
|
||||
--insecure-sha1-intermediate allows to use insecure TLS protocols, such as SHA-1
|
||||
--insecure-tls-version allows to use TLS versions 1.0 and 1.1
|
||||
--json the output format will be in json format
|
||||
--local allows communicating with the server through a unix socket
|
||||
--quiet prevent mmctl to generate output for the commands
|
||||
--strict will only run commands if the mmctl version matches the server one
|
||||
--suppress-warnings disables printing warning messages
|
||||
|
||||
SEE ALSO
|
||||
~~~~~~~~
|
||||
|
||||
* `mmctl compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _mmctl_compliance_export_list:
|
||||
.. _mmctl_compliance-export_list:
|
||||
|
||||
mmctl compliance_export list
|
||||
mmctl compliance-export list
|
||||
----------------------------
|
||||
|
||||
List compliance export jobs, sorted by creation date descending (newest first)
|
||||
@@ -13,7 +13,7 @@ List compliance export jobs, sorted by creation date descending (newest first)
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance_export list [flags]
|
||||
mmctl compliance-export list [flags]
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
@@ -43,5 +43,5 @@ Options inherited from parent commands
|
||||
SEE ALSO
|
||||
~~~~~~~~
|
||||
|
||||
* `mmctl compliance_export <mmctl_compliance_export.rst>`_ - Management of compliance exports
|
||||
* `mmctl compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
.. _mmctl_compliance_export_show:
|
||||
.. _mmctl_compliance-export_show:
|
||||
|
||||
mmctl compliance_export show
|
||||
mmctl compliance-export show
|
||||
----------------------------
|
||||
|
||||
Show compliance export job
|
||||
@@ -13,14 +13,14 @@ Show compliance export job
|
||||
|
||||
::
|
||||
|
||||
mmctl compliance_export show [complianceExportJobID] [flags]
|
||||
mmctl compliance-export show [complianceExportJobID] [flags]
|
||||
|
||||
Examples
|
||||
~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
compliance_export show o98rj3ur83dp5dppfyk5yk6osy
|
||||
compliance-export show o98rj3ur83dp5dppfyk5yk6osy
|
||||
|
||||
Options
|
||||
~~~~~~~
|
||||
@@ -47,5 +47,5 @@ Options inherited from parent commands
|
||||
SEE ALSO
|
||||
~~~~~~~~
|
||||
|
||||
* `mmctl compliance_export <mmctl_compliance_export.rst>`_ - Management of compliance exports
|
||||
* `mmctl compliance-export <mmctl_compliance-export.rst>`_ - Management of compliance exports
|
||||
|
||||
Ссылка в новой задаче
Block a user