Compare commits

...

No commits in common. "5192ae5356752247c083d0cb0a6dc256c267af5a" and "1863ff393aa07177bd5d8cde3c3bd3ab28c7da71" have entirely different histories.

14 changed files with 1206 additions and 1206 deletions

View File

@ -5,7 +5,7 @@ This page provides an index of the available documentation for the FarmMaps plat
## Getting started
The main starting point for Farmmaps API access is the REST API.
To get started, follow the steps below.
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](Workflow) and [FarmMaps Main Components](Main-components.md) pages.
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](Workflow.md) and [FarmMaps Main Components](Main-components.md) pages.
### Environments

View File

@ -1,7 +1,7 @@
# Integrating FarmMaps OpenID Connect
Farmmaps uses OpenID Connect (OIDC).
This page lists the information needed to integrate OpenID connect into your application.
Note that for testing purposes it is quicker to just [generate an access token](.md) instead of implementing a complete integration.
Note that for testing purposes it is quicker to just [generate an access token]() instead of implementing a complete integration.
Please see [https://openid.net/connect/](https://openid.net/connect/) if you are not familiar with OpenID Connect.
To integrate OIDC, it is recommended to use a (certified) library/implementation for your language of choice:
@ -21,7 +21,7 @@ More about flow types can be found [here](https://www.scottbrady91.com/OpenID-Co
* At the moment, FarmMaps does not support dynamic client registration.
Please request a client id from one of our developers when you need one for your application.
In the meantime, it is recommended to simply [generate an access token](.md) to explore the REST API.
In the meantime, it is recommended to simply [generate an access token]() to explore the REST API.

View File

@ -67,7 +67,7 @@ The REST API is the primary API for FarmMaps and allows you to:
* Run other tasks (create a taskmap, create cropfield etc.)
* Monitor the progress of the processing tasks
Several how-to's can be found in the [examples folder][examples/]
Several how-to's can be found in the [examples folder][/wiki/examples/]
There's also swagger based reference of the [REST API](https://farmmaps.awacc.nl/swagger/index.html)
#### MQTT Endpoint

View File

@ -4,7 +4,7 @@ The same workflow can be followed for different languages, as long as there's a
FarmMaps provides an MQTT endpoint to allow your application to send signals to FarmMaps, and listen for events.
These signals are collected in a "message queue".
If you are not familiar with anything mentioned, please see the [FAQ](#faq.md) at the end.
If you are not familiar with anything mentioned, please see the [FAQ](#faq) at the end.
### Prerequisites
To follow along with the examples, you need:
@ -162,7 +162,7 @@ For now, we'll stick with the pregenerated protobuf class.
* [Protobuf documentation](https://developers.google.com/protocol-buffers/docs/overview)
* [Paho MQTT documentation](https://www.eclipse.org/paho/clients/python/docs/)
## [FAQ](#faq.md)
## [FAQ](#faq)
#### How do I install the required Python modules?
This tutorial requires the `paho-mqtt` and `protobuf` modules.
These can be installed with the following commands:

View File

@ -259,7 +259,7 @@ Vary: Accept-Encoding
## What's next?
Now that you know how to run a task, you can start running specialized tasks to create or process your own data.
Head over to the [Task Examples](Home#task-examples.md)
Head over to the [Task Examples](README.md#task-examples)

View File

@ -2,7 +2,7 @@
[<< Home](README.md)
FarmMaps is an asynchronous architecture, the API flow keeps this in mind.
The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow.
The API 2 that all data is already processed and available provided, for example through the normal FarmMaps flow.
For the currently available public FarmMaps API you can take a look at swagger: http://farmmaps.awtest.nl/swagger/index.html