You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@syncope.apache.org by il...@apache.org on 2020/03/27 11:48:05 UTC

[syncope] 02/02: [SYNCOPE-1514] Reporting CLI deprecation

This is an automated email from the ASF dual-hosted git repository.

ilgrosso pushed a commit to branch 2_1_X
in repository https://gitbox.apache.org/repos/asf/syncope.git

commit fbc63e4d765db066a096e5dd0eb5d79f331b8966
Author: Francesco Chicchiriccò <il...@apache.org>
AuthorDate: Fri Mar 27 12:45:42 2020 +0100

    [SYNCOPE-1514] Reporting CLI deprecation
---
 src/main/asciidoc/getting-started/obtain.adoc             | 15 +++++++++++++--
 .../reference-guide/architecture/architecture.adoc        | 11 +++++++++++
 2 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/src/main/asciidoc/getting-started/obtain.adoc b/src/main/asciidoc/getting-started/obtain.adoc
index 6bae992..014eb6c 100644
--- a/src/main/asciidoc/getting-started/obtain.adoc
+++ b/src/main/asciidoc/getting-started/obtain.adoc
@@ -726,11 +726,22 @@ You can configure any LDAP client (such as http://jxplorer.org/[JXplorer^], for
 The command-line interface (CLI) client is an utility tool meant for interacting with Apache Syncope deployments from
 shell scripts.
 
+[WARNING]
+.Deprecation
+====
+Syncope 2.1 is the last major version providing CLI.
+
+As an alternative you can consider using the popular http://curl.haxx.se/[curl^] tool to invoke the
+Syncope Core REST API services. +
+For reference, the Swagger UI extension, when enabled, will provide for each request the corresponding `curl` command
+with all parameters.
+====
+
 Once downloaded and uncompressed, you will find a `lib` directory and two scripts: `syncopeadm.sh` and `syncopeadm.bat`,
 which will be used depending on the operating system.
 
-The installation process creates `cli.properties`, which contains all the required information to invoke the Apache 
-Syncope REST API services.
+The installation process creates `cli.properties`, which contains all the required information to invoke the 
+Syncope Core REST API services.
 The file content looks like the following:
 
 ....
diff --git a/src/main/asciidoc/reference-guide/architecture/architecture.adoc b/src/main/asciidoc/reference-guide/architecture/architecture.adoc
index 64611a9..e7255f7 100644
--- a/src/main/asciidoc/reference-guide/architecture/architecture.adoc
+++ b/src/main/asciidoc/reference-guide/architecture/architecture.adoc
@@ -200,6 +200,17 @@ The communication between CLI and Core is exclusively REST-based.
 
 More details are available in the dedicated <<cli,usage>> section.
 
+[WARNING]
+.Deprecation
+====
+Syncope 2.1 is the last major version providing CLI.
+
+As an alternative you can consider using the popular http://curl.haxx.se/[curl^] tool to invoke the
+Syncope Core REST API services. +
+For reference, the Swagger UI extension, when enabled, will provide for each request the corresponding `curl` command
+with all parameters.
+====
+
 === Third Party Applications
 
 Third-party applications are provided full access to IdM services by leveraging the REST interface, either via the