[MM-62888] mmctl: Add compliance export list cmd (#30914)

* Add compliance export list cmd and tests

- Introduced `ListComplianceExports` method in the Client interface to retrieve compliance export jobs.
- Added `compliance_export` command with subcommand `list` for listing compliance export jobs, including pagination options.
- Implemented end-to-end and unit tests for the compliance export listing functionality.

* Add docs for mmctl

* fix test typo

* added paging, tested

* update docs with better desc (how it's sorted)

* simplified, reusing job call

* add show cmd, unit tests, e2e tests

* update mmctl docs
Этот коммит содержится в:
Christopher Poile
2025-06-24 11:20:40 -04:00
коммит произвёл GitHub
родитель 5d7c3b52ed
Коммит 9399398e04
8 изменённых файлов: 593 добавлений и 4 удалений

Просмотреть файл

@@ -35,6 +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 config <mmctl_config.rst>`_ - Configuration
* `mmctl docs <mmctl_docs.rst>`_ - Generates mmctl documentation
* `mmctl export <mmctl_export.rst>`_ - Management of exports

Просмотреть файл

@@ -0,0 +1,42 @@
.. _mmctl_compliance_export:
mmctl compliance_export
-----------------------
Management of compliance exports
Synopsis
~~~~~~~~
Management of compliance exports
Options
~~~~~~~
::
-h, --help help for compliance_export
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 <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

Просмотреть файл

@@ -0,0 +1,47 @@
.. _mmctl_compliance_export_list:
mmctl compliance_export list
----------------------------
List compliance export jobs, sorted by creation date descending (newest first)
Synopsis
~~~~~~~~
List compliance export jobs, sorted by creation date descending (newest first)
::
mmctl compliance_export list [flags]
Options
~~~~~~~
::
--all Fetch all compliance export jobs. --page flag will be ignored if provided
-h, --help help for list
--page int Page number to fetch for the list of compliance export jobs
--per-page int Number of compliance export jobs to be fetched (default 200)
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

Просмотреть файл

@@ -0,0 +1,51 @@
.. _mmctl_compliance_export_show:
mmctl compliance_export show
----------------------------
Show compliance export job
Synopsis
~~~~~~~~
Show compliance export job
::
mmctl compliance_export show [complianceExportJobID] [flags]
Examples
~~~~~~~~
::
compliance_export show o98rj3ur83dp5dppfyk5yk6osy
Options
~~~~~~~
::
-h, --help help for show
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