From d44cb5b75db9418345d7ffc3c73a478d14b80514 Mon Sep 17 00:00:00 2001 From: Dusan Borovcanin Date: Thu, 25 Jan 2024 18:01:44 +0100 Subject: [PATCH] Fix docs Signed-off-by: Dusan Borovcanin --- README.md | 4 +--- docs/api.md | 16 ++++++++-------- mkdocs.yml | 2 +- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e7381369..70fde9f4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Magistrala [![license][license]](LICENSE) -[![chat][gitter-badge]][gitter] This repo collects the collaborative work on Magistrala documentation. The official documentation is hosted at [Magistrala Docs page][docs]. @@ -55,8 +54,7 @@ Thank you for your interest in Magistrala and the desire to contribute! [Apache-2.0](LICENSE) [matrix]: https://matrix.to/#/#Mainflux_mainflux:gitter.im -[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg [license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg [blog]: https://medium.com/abstract-machines-blog [twitter]: https://twitter.com/absmach -[docs]: https://docs.magistrala.abstractmachines.io +[docs]: https://docs.magistrala.abstractmachines.fr diff --git a/docs/api.md b/docs/api.md index 827d0c8e..f1623474 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,13 +2,13 @@ ## Reference -API reference in the Swagger UI can be found at: [https://api.mainflux.io][api] +API reference in the Swagger UI can be found at: [https://api.magistrala.abstractmachines.fr][api] ## Users ### Create User -To start working with the Magistrala system, you need to create a user account. +To start working with the Mainflux system, you need to create a user account. > Identity, which can be email-address (this must be unique as it identifies the user) and secret (password must contain at least 8 characters). @@ -97,7 +97,7 @@ Access-Control-Expose-Headers: Location ### Create Token -To log in to the Magistrala system, you need to create a `user_token`. +To log in to the Mainflux system, you need to create a `user_token`. ```bash curl -sSiX POST http://localhost/users/tokens/issue -H "Content-Type: application/json" -d @- << EOF @@ -682,9 +682,9 @@ Access-Control-Expose-Headers: Location ### Create Thing with External ID -It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Magistrala platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Magistrala Things metadata, it is possible to set Magistrala Thing ID with an existing unique ID while create the Thing. This way, the user can set the existing ID as the Thing ID of a newly created Thing to keep reference between Thing and the asset that Thing represents. +It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Mainflux platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Mainflux Things metadata, it is possible to set Mainflux Thing ID with an existing unique ID while create the Thing. This way, the user can set the existing ID as the Thing ID of a newly created Thing to keep reference between Thing and the asset that Thing represents. -The limitation is that the existing ID has to be unique in the Magistrala domain. +The limitation is that the existing ID has to be unique in the Mainflux domain. To create a thing with an external ID, you need to provide the ID together with thing name, and other fields as well as a `user_token` @@ -720,8 +720,8 @@ Access-Control-Expose-Headers: Location ### Create Thing with External Secret -It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Magistrala platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Magistrala Things metadata, it is possible to set Magistrala Thing secret with an existing unique secret when creating the Thing. This way, the user can set the existing secret as the Thing secret of a newly created Thing to keep reference between Thing and the asset that Thing represents. -The limitation is that the existing secret has to be unique in the Magistrala domain. +It is often the case that the user will want to integrate the existing solutions, e.g. an asset management system, with the Mainflux platform. To simplify the integration between the systems and avoid artificial cross-platform reference, such as special fields in Mainflux Things metadata, it is possible to set Mainflux Thing secret with an existing unique secret when creating the Thing. This way, the user can set the existing secret as the Thing secret of a newly created Thing to keep reference between Thing and the asset that Thing represents. +The limitation is that the existing secret has to be unique in the Mainflux domain. To create a thing with an external secret, you need to provide the secret together with thing name, and other fields as well as a `user_token` @@ -1357,7 +1357,7 @@ Access-Control-Expose-Headers: Location ### Create Channel with external ID -Channel is a group of things that could represent a special category in existing systems, e.g. a building level channel could represent the level of a smarting building system. For helping to keep the reference, it is possible to set an existing ID while creating the Magistrala channel. There are two limitations - the existing ID has to be in UUID V4 format and it has to be unique in the Magistrala domain. +Channel is a group of things that could represent a special category in existing systems, e.g. a building level channel could represent the level of a smarting building system. For helping to keep the reference, it is possible to set an existing ID while creating the Mainflux channel. There are two limitations - the existing ID has to be in UUID V4 format and it has to be unique in the Mainflux domain. To create a channel with external ID, the user needs to provide a UUID v4 format unique ID, and a `user_token` diff --git a/mkdocs.yml b/mkdocs.yml index 532b46d2..e369e635 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,7 +7,7 @@ copyright: Copyright (c) Abstract Machines repo_url: https://github.com/absmach/magistrala site_description: Magistrala IoT System site_name: Magistrala -site_url: https://docs.mainflux.io +site_url: https://docs.magistrala.abstractmachines.fr edit_uri: "" theme: name: material