Skip to content

Commit

Permalink
Fix links in README file
Browse files Browse the repository at this point in the history
Remove GPL3-licenced test dependencies

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>
  • Loading branch information
dborovcanin committed Mar 29, 2024
1 parent ed4824d commit 02ba02f
Show file tree
Hide file tree
Showing 55 changed files with 82 additions and 80 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/swagger-ui.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: swagger-ui
cname: api.mainflux.io
cname: docs.api.magistrala.abstractmachines.fr
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Check that `.env` file contains:
MG_RELEASE_TAG=<release_number>
```

> `docker-compose` should be used for development and testing deployments. For production we suggest using [Kubernetes](https://docs.mainflux.io/kubernetes).
> `docker-compose` should be used for development and testing deployments. For production we suggest using [Kubernetes](https://docs.magistrala.abstractmachines.fr/kubernetes).
## Usage

Expand All @@ -87,11 +87,11 @@ make cli
./build/cli version
```

Additional details on using the CLI can be found in the [CLI documentation](https://docs.mainflux.io/cli).
Additional details on using the CLI can be found in the [CLI documentation](https://docs.magistrala.abstractmachines.fr/cli).

## Documentation

Official documentation is hosted at [Magistrala official docs page][docs]. Documentation is auto-generated, checkout the instructions on [official docs repository](https://github.com/mainflux/docs):
Official documentation is hosted at [Magistrala official docs page][docs]. Documentation is auto-generated, checkout the instructions on [official docs repository](https://github.com/absmach/magistrala-docs):

If you spot an error or a need for corrections, please let us know - or even better: send us a PR.

Expand Down Expand Up @@ -137,8 +137,7 @@ You like Magistrala and you would like to make it your day job? We're always loo

[Apache-2.0](LICENSE)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmainflux%2Fmainflux.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmainflux%2Fmainflux?ref=badge_large)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fabsmach%2Fmagistrala.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fabsmach%2Fmagistrala?ref=badge_shield&issueType=license)
## Data Collection for Magistrala

Magistrala is committed to continuously improving its services and ensuring a seamless experience for its users. To achieve this, we collect certain data from your deployments. Rest assured, this data is collected solely for the purpose of enhancing Magistrala and is not used with any malicious intent. The deployment summary can be found on our [website][callhome].
Expand All @@ -157,8 +156,8 @@ Data collection is on by default and can be disabled by setting the env variable

By utilizing Magistrala, you actively contribute to its improvement. Together, we can build a more robust and efficient IoT platform. Thank you for your trust in Magistrala!

[banner]: https://github.com/mainflux/docs/blob/master/docs/img/gopherBanner.jpg
[docs]: https://docs.mainflux.io
[banner]: https://github.com/absmach/magistrala-docs/blob/master/docs/img/gopherBanner.jpg
[docs]: https://docs.magistrala.abstractmachines.fr
[docker]: https://www.docker.com
[forum]: https://groups.google.com/forum/#!forum/mainflux
[gitter]: https://gitter.im/absmach/magistrala?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
Expand All @@ -171,8 +170,8 @@ By utilizing Magistrala, you actively contribute to its improvement. Together, w
[twitter]: https://twitter.com/mainflux
[lora]: https://lora-alliance.org/
[opcua]: https://opcfoundation.org/about/opc-technologies/opc-ua/
[agent]: https://github.com/mainflux/agent
[export]: https://github.com/mainflux/export
[agent]: https://github.com/absmach/agent
[export]: https://github.com/absmach/export
[kubernetes]: https://kubernetes.io/
[releases]: https://github.com/absmach/magistrala/releases
[drasko]: https://github.com/drasko
Expand All @@ -190,4 +189,4 @@ By utilizing Magistrala, you actively contribute to its improvement. Together, w
[dusanm]: https://github.com/malidukica
[mirko]: https://github.com/mteodor
[rodneyosodo]: https://github.com/rodneyosodo
[callhome]: https://deployments.mainflux.io
[callhome]: https://deployments.magistrala.abstractmachines.fr/
2 changes: 1 addition & 1 deletion api/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This folder contains an OpenAPI specifications for Magistrala API.

View specification in Swagger UI at [api.mainflux.io](https://api.mainflux.io)
View specification in Swagger UI at [docs.api.magistrala.abstractmachines.fr](https://docs.api.magistrala.abstractmachines.fr)
4 changes: 2 additions & 2 deletions auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,6 @@ Setting `MG_AUTH_GRPC_SERVER_CERT` and `MG_AUTH_GRPC_SERVER_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=auth.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=auth.yml).

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion auth/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion bootstrap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,4 @@ Setting `MG_AUTH_GRPC_CLIENT_CERT` and `MG_AUTH_GRPC_CLIENT_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=bootstrap.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=bootstrap.yml).
2 changes: 1 addition & 1 deletion bootstrap/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion certs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,4 @@ Setting `MG_AUTH_GRPC_CLIENT_CERT` and `MG_AUTH_GRPC_CLIENT_KEY` will enable TLS

## Usage

For more information about service capabilities and its usage, please check out the [Certs section](https://docs.mainflux.io/certs/).
For more information about service capabilities and its usage, please check out the [Certs section](https://docs.magistrala.abstractmachines.fr/certs/).
2 changes: 1 addition & 1 deletion certs/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users Groups service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion coap/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala WebSocket adapter service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
4 changes: 2 additions & 2 deletions consumers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ For an in-depth explanation of the usage of `consumers`, as well as thorough
understanding of Magistrala, please check out the [official documentation][doc].

For more information about service capabilities and its usage, please check out
the [API documentation](https://api.mainflux.io/?urls.primaryName=consumers-notifiers-openapi.yml).
the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/notifiers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ default values.

Subscriptions service will start consuming messages and sending notifications when a message is received.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/notifiers/smtp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ default values.

Starting service will start consuming messages and sending emails when a message is received.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/notifiers/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala WebSocket adapter service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion consumers/writers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ the [Docker Compose][compose] file.
For an in-depth explanation of the usage of `writers`, as well as thorough
understanding of Magistrala, please check out the [official documentation][doc].

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
[compose]: ../docker/docker-compose.yml
2 changes: 1 addition & 1 deletion consumers/writers/cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ execute following command:

Starting service will start consuming normalized messages in SenML format.

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
2 changes: 1 addition & 1 deletion consumers/writers/influxdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ _Please note that you need to start core services before the additional ones._

Starting service will start consuming normalized messages in SenML format.

Official docs can be found [here](https://docs.mainflux.io).
Official docs can be found [here](https://docs.magistrala.abstractmachines.fr).
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ go 1.21.5
toolchain go1.21.6

require (
github.com/0x6flab/namegenerator v1.2.0
github.com/absmach/callhome v0.14.0
github.com/absmach/mproxy v0.4.2
github.com/absmach/senml v1.0.5
Expand All @@ -23,6 +22,7 @@ require (
github.com/gocql/gocql v1.6.0
github.com/gofrs/uuid v4.4.0+incompatible
github.com/gookit/color v1.5.4
github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e
github.com/gopcua/opcua v0.1.6
github.com/gorilla/websocket v1.5.1
github.com/hashicorp/vault/api v1.12.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ cloud.google.com/go/compute v1.23.3 h1:6sVlXXBmbd7jNX0Ipq0trII3e4n1/MsADLK6a+aiV
cloud.google.com/go/compute v1.23.3/go.mod h1:VCgBUoMnIVIR0CscqQiPJLAG25E3ZRZMzcFZeQ+h8CI=
cloud.google.com/go/compute/metadata v0.2.3 h1:mg4jlk7mCAj6xXp9UJ4fjI9VUI5rubuGBW5aJ7UnBMY=
cloud.google.com/go/compute/metadata v0.2.3/go.mod h1:VAV5nSsACxMJvgaAuX6Pk2AawlZn8kiOGuCv6gTkwuA=
github.com/0x6flab/namegenerator v1.2.0 h1:RuHRO7NDGQpZ9ajRFP5ALcl66cyi0hqjs1fXDV+3pZE=
github.com/0x6flab/namegenerator v1.2.0/go.mod h1:h28wadnJ13Q7PxpUzAHckVj9ToyAEdx5T186Zj1kp+k=
github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161 h1:L/gRVlceqvL25UVaW/CKtUDjefjrs0SPonmDGUVOYP0=
github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
Expand Down Expand Up @@ -195,6 +193,8 @@ github.com/google/uuid v1.5.0 h1:1p67kYwdtXjb0gL0BPiP1Av9wiZPo5A8z2cWkTZ+eyU=
github.com/google/uuid v1.5.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gookit/color v1.5.4 h1:FZmqs7XOyGgCAxmWyPslpiok1k05wmY3SJTytgvYFs0=
github.com/gookit/color v1.5.4/go.mod h1:pZJOeOS8DM43rXbp4AZo1n9zCU2qjpcRko0b6/QJi9w=
github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e h1:XmA6L9IPRdUr28a+SK/oMchGgQy159wvzXA5tJ7l+40=
github.com/goombaio/namegenerator v0.0.0-20181006234301-989e774b106e/go.mod h1:AFIo+02s+12CEg8Gzz9kzhCbmbq6JcKNrhHffCGA9z4=
github.com/gopcua/opcua v0.1.6 h1:B9SVRKQGzcWcwP2QPYN93Uku32+3wL+v5cgzBxE6V5I=
github.com/gopcua/opcua v0.1.6/go.mod h1:INwnDoRxmNWAt7+tzqxuGqQkSF2c1C69VAL0c2q6AcY=
github.com/gorilla/mux v1.7.4/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
Expand Down
2 changes: 1 addition & 1 deletion http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ Setting `MG_THINGS_AUTH_GRPC_CLIENT_CERT` and `MG_THINGS_AUTH_GRPC_CLIENT_KEY` w

## Usage

HTTP Authorization request header contains the credentials to authenticate a Thing. The authorization header can be a plain Thing key or a Thing key encoded as a password for Basic Authentication. In case the Basic Authentication schema is used, the username is ignored. For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=http.yml).
HTTP Authorization request header contains the credentials to authenticate a Thing. The authorization header can be a plain Thing key or a Thing key encoded as a password for Basic Authentication. In case the Basic Authentication schema is used, the username is ignored. For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=http.yml).
4 changes: 2 additions & 2 deletions internal/groups/postgres/groups_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ import (
"testing"
"time"

"github.com/0x6flab/namegenerator"
"github.com/absmach/magistrala/internal/groups/postgres"
"github.com/absmach/magistrala/internal/testsutil"
"github.com/absmach/magistrala/pkg/clients"
"github.com/absmach/magistrala/pkg/errors"
repoerr "github.com/absmach/magistrala/pkg/errors/repository"
mggroups "github.com/absmach/magistrala/pkg/groups"
"github.com/goombaio/namegenerator"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

var (
namegen = namegenerator.NewNameGenerator()
namegen = namegenerator.NewNameGenerator(time.Now().UTC().UnixNano())
invalidID = strings.Repeat("a", 37)
validGroup = mggroups.Group{
ID: testsutil.GenerateUUID(&testing.T{}),
Expand Down
4 changes: 2 additions & 2 deletions internal/groups/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"testing"
"time"

"github.com/0x6flab/namegenerator"
"github.com/absmach/magistrala"
"github.com/absmach/magistrala/auth"
authmocks "github.com/absmach/magistrala/auth/mocks"
Expand All @@ -23,14 +22,15 @@ import (
mggroups "github.com/absmach/magistrala/pkg/groups"
"github.com/absmach/magistrala/pkg/groups/mocks"
"github.com/absmach/magistrala/pkg/uuid"
"github.com/goombaio/namegenerator"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
)

var (
idProvider = uuid.New()
token = "token"
namegen = namegenerator.NewNameGenerator()
namegen = namegenerator.NewNameGenerator(time.Now().UTC().UnixNano())
validGroup = mggroups.Group{
Name: namegen.Generate(),
Description: namegen.Generate(),
Expand Down
2 changes: 1 addition & 1 deletion internal/groups/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala Users Groups service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion invitations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ $GOBIN/magistrala-invitation

## Usage

For more information about service capabilities and its usage, please check out the [API documentation](https://api.mainflux.io/?urls.primaryName=invitations.yml).
For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=invitations.yml).
2 changes: 1 addition & 1 deletion lora/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ docker-compose -f docker/addons/lora-adapter/docker-compose.yml up -d

## Usage

For more information about service capabilities and its usage, please check out the [Magistrala documentation](https://docs.mainflux.io/lora).
For more information about service capabilities and its usage, please check out the [Magistrala documentation](https://docs.magistrala.abstractmachines.fr/lora).
2 changes: 1 addition & 1 deletion mqtt/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala MQTT adapter service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion opcua/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ docker-compose -f docker/addons/opcua-adapter/docker-compose.yml up -d

## Usage

For more information about service capabilities and its usage, please check out the [Magistrala documentation](https://docs.mainflux.io/opcua).
For more information about service capabilities and its usage, please check out the [Magistrala documentation](https://docs.magistrala.abstractmachines.fr/opcua).
4 changes: 2 additions & 2 deletions pkg/clients/postgres/clients_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"testing"
"time"

"github.com/0x6flab/namegenerator"
ipostgres "github.com/absmach/magistrala/internal/postgres"
"github.com/absmach/magistrala/internal/testsutil"
"github.com/absmach/magistrala/pkg/clients"
Expand All @@ -20,14 +19,15 @@ import (
pgclients "github.com/absmach/magistrala/pkg/clients/postgres"
"github.com/absmach/magistrala/pkg/errors"
repoerr "github.com/absmach/magistrala/pkg/errors/repository"
"github.com/goombaio/namegenerator"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

var (
password = "$tr0ngPassw0rd"
emailSuffix = "@example.com"
namegen = namegenerator.NewNameGenerator()
namegen = namegenerator.NewNameGenerator(time.Now().UTC().UnixNano())
)

func TestRetrieveByID(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion pkg/messaging/nats/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala things policies service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion pkg/messaging/rabbitmq/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala things policies service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion pkg/messaging/tracing/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
// Magistrala things policies service.
//
// For more details about tracing instrumentation for Magistrala messaging refer
// to the documentation at https://docs.mainflux.io/tracing/.
// to the documentation at https://docs.magistrala.abstractmachines.fr/tracing/.
package tracing
2 changes: 1 addition & 1 deletion readers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Readers provide implementations of various `message readers`. Message readers ar

For an in-depth explanation of the usage of `reader`, as well as thorough understanding of Magistrala, please check out the [official documentation][doc].

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
4 changes: 2 additions & 2 deletions readers/cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ docker-compose -f docker/addons/casandra-reader/docker-compose.yml up -d

## Usage

Service exposes [HTTP API](https://api.mainflux.io/?urls.primaryName=readers-openapi.yml) for fetching messages.
Service exposes [HTTP API](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=readers-openapi.yml) for fetching messages.

```
Note: Cassandra Reader doesn't support searching substrings from string_value, due to inefficient searching as the current data model is not suitable for this type of queries.
```

[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
4 changes: 2 additions & 2 deletions readers/influxdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ docker-compose -f docker/addons/influxdb-reader/docker-compose.yml up --env-file
## Usage
Service exposes [HTTP API](https://api.mainflux.io/?urls.primaryName=readers-openapi.yml) for fetching messages.
Service exposes [HTTP API](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=readers-openapi.yml) for fetching messages.
Comparator Usage Guide:
| Comparator | Usage | Example |
Expand All @@ -123,4 +123,4 @@ Comparator Usage Guide:
| le | Return values that are superstrings of the query | le["active"] -> "tiv" |
| lt | Return values that are superstrings of the query and not equal to the query | lt["active"] -> "active" and "tiv" |
Official docs can be found [here](https://docs.mainflux.io).
Official docs can be found [here](https://docs.magistrala.abstractmachines.fr).
4 changes: 2 additions & 2 deletions readers/mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,10 @@ docker-compose -f docker/addons/mongodb-reader/docker-compose.yml up -d
## Usage
Service exposes [HTTP API](https://api.mainflux.io/?urls.primaryName=readers-openapi.yml) for fetching messages.
Service exposes [HTTP API](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=readers-openapi.yml) for fetching messages.
```
Note: MongoDB Reader doesn't support searching substrings from string_value, due to inefficient searching as the current data model is not suitable for this type of queries.
```
[doc]: https://docs.mainflux.io
[doc]: https://docs.magistrala.abstractmachines.fr
Loading

0 comments on commit 02ba02f

Please sign in to comment.