From 5f2c48dcb6387440a38fd56bfaedf65d3bc926e8 Mon Sep 17 00:00:00 2001 From: Karim <37943746+ksaadDE@users.noreply.github.com> Date: Tue, 14 Jun 2022 01:55:49 +0200 Subject: [PATCH 1/3] updated docs to new partly --- doc/rest_api.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/rest_api.rst b/doc/rest_api.rst index 70178848b..ad41a0c16 100644 --- a/doc/rest_api.rst +++ b/doc/rest_api.rst @@ -10,8 +10,9 @@ documentation. You will find them using the following url patterns: * API: *http:///api/v1/* * Documentation: *http:///docs/api/* +* New Docs: *https:///api/schema-v2/swagger/* -An `example `_ of this +An `old example `_ of this and here: `new example `_ documentation is available on the official demo. Using this API requires an authentication and for now, only a token From b1df4b8ab52d4533c514ba48668702341a38a26f Mon Sep 17 00:00:00 2001 From: Karim <37943746+ksaadDE@users.noreply.github.com> Date: Mon, 25 Jul 2022 22:58:21 +0200 Subject: [PATCH 2/3] Updated as requested Old-New-Api clarification --- doc/rest_api.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/rest_api.rst b/doc/rest_api.rst index ad41a0c16..31db735e0 100644 --- a/doc/rest_api.rst +++ b/doc/rest_api.rst @@ -8,11 +8,12 @@ Modoboa provides a REST API. Every installed instance comes with a ready-to-use API and a documentation. You will find them using the following url patterns: -* API: *http:///api/v1/* -* Documentation: *http:///docs/api/* -* New Docs: *https:///api/schema-v2/swagger/* +* New API+Docs: *https:///api/schema-v2/swagger/* +* Old API: *http:///api/v1/ +* (Old) Documentation: *http:///docs/api/* -An `old example `_ of this and here: `new example `_ +`new example `_ +An `old example `_ documentation is available on the official demo. Using this API requires an authentication and for now, only a token From 794be4039db9b7712641ab98f3a509580936cf88 Mon Sep 17 00:00:00 2001 From: Karim <37943746+ksaadDE@users.noreply.github.com> Date: Mon, 25 Jul 2022 23:00:07 +0200 Subject: [PATCH 3/3] updated as requested (fix) --- doc/rest_api.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/rest_api.rst b/doc/rest_api.rst index 31db735e0..13cb23ef7 100644 --- a/doc/rest_api.rst +++ b/doc/rest_api.rst @@ -6,14 +6,18 @@ To ease the integration with external sources (software or other), Modoboa provides a REST API. Every installed instance comes with a ready-to-use API and a -documentation. You will find them using the following url patterns: +documentation. + +**You will find them using the following url patterns:** * New API+Docs: *https:///api/schema-v2/swagger/* * Old API: *http:///api/v1/ * (Old) Documentation: *http:///docs/api/* -`new example `_ -An `old example `_ +**Examples:** + +* `new example `_ +* `old example `_ documentation is available on the official demo. Using this API requires an authentication and for now, only a token