FarmMaps/Documentatie
8
0
Fork 0
Code Pull Requests Releases Activity

fixed links

Browse Source
This commit is contained in:
Mark van der Wal 2020-05-07 18:43:58 +02:00
parent a539efb65d
commit 1863ff393a
8 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.idea/

18
Home.md
View File

@ -5,7 +5,7 @@ This page provides an index of the available documentation for the FarmMaps plat
## Getting started ## Getting started
The main starting point for Farmmaps API access is the REST API. The main starting point for Farmmaps API access is the REST API.
To get started, follow the steps below. To get started, follow the steps below.
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](/wiki/Workflow) and [FarmMaps Main Components](/wiki/Main-components) 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 ### Environments
@ -47,8 +47,8 @@ For each request, the access token needs to be sent along. This access token pro
To continue please see one of the articles below: To continue please see one of the articles below:
- [Integrating FarmMaps Open ID Connect into your application](/wiki/Integrating-FarmMaps-OIDC) - [Integrating FarmMaps Open ID Connect into your application](Integrating-FarmMaps-OIDC.md)
- [Creating an access token for testing.](/wiki/Create-access-token) - [Creating an access token for testing.](Create-access-token.md)
## Using the FarmMaps API ## Using the FarmMaps API
Once you have an access token, you can start querying the API. Once you have an access token, you can start querying the API.
@ -57,17 +57,17 @@ The API basics are uploading files, creating items and and running tasks to modi
For testing purposes, [Postman](https://www.postman.com) can be used to perform HTTP requests more easily. For testing purposes, [Postman](https://www.postman.com) can be used to perform HTTP requests more easily.
We provide the following guides: We provide the following guides:
* [Uploading a file](/wiki/Upload-a-file) * [Uploading a file](Upload-a-file.md)
* [Creating a cropfield](/wiki/Create-a-cropfield) * [Creating a cropfield](Create-a-cropfield.md)
* [Running a task](/wiki/Running-tasks) * [Running a task](Running-tasks.md)
Generally, tasks can be run in the same way. Generally, tasks can be run in the same way.
However, each specific task has it's own inputs and properties. However, each specific task has it's own inputs and properties.
How these work can be found in the use task examples below. How these work can be found in the use task examples below.
### <a name="task-examples"></a>Task examples ### <a name="task-examples"></a>Task examples
* [VRAPoten-API](/wiki/VRAPoten-API) * [VRAPoten-API](VRAPoten-API.md)
* [VRANbs-API](/wiki/VRANbs-API) * [VRANbs-API](VRANbs-API.md)
* [VRAHerbicide-API](/wiki/VRAHerbicide-API) * [VRAHerbicide-API](VRAHerbicide-API.md)

6
Main-components.md
View File

@ -73,14 +73,14 @@ There's also swagger based reference of the [REST API](https://farmmaps.awacc.nl
#### MQTT Endpoint #### MQTT Endpoint
The MQTT Endpoint provides a way to input more stream like data like a live GPS location, or live temperature measurement to FarmMaps. The MQTT Endpoint provides a way to input more stream like data like a live GPS location, or live temperature measurement to FarmMaps.
This endpoint is still under development. If you would like to build on top of this endpoint, please contact the FarmMaps development team. This endpoint is still under development. If you would like to build on top of this endpoint, please contact the FarmMaps development team.
As a reference, please also see [Sending data to MQTT](/wiki/Message-Queue-Endpoint). As a reference, please also see [Sending data to MQTT](Message-Queue-Endpoint.md).
### Data processing infrastructure ### Data processing infrastructure
To process the data that is provided through the endpoints, FarmMaps uses queues and workers to manage the execution of these tasks. To process the data that is provided through the endpoints, FarmMaps uses queues and workers to manage the execution of these tasks.
How this works is described in [the workflow article](/wiki/Workflow) How this works is described in [the workflow article](Workflow.md)
### Viewer ### Viewer
To visualize all data in the FarmMaps backend, FarmMaps integrates it's own viewer. To visualize all data in the FarmMaps backend, FarmMaps integrates it's own viewer.
This viewer is available as an open source project and can be found in the [FarmMapsLibs Repository](https://git.akkerweb.nl/FarmMaps/FarmMapsLib). This viewer is available as an open source project and can be found in the [FarmMapsLibs Repository](https://git.akkerweb.nl/FarmMaps/FarmMapsLib).
There's also a separate documentation page which can be found [here](/wiki/FarmMapsLibs). [under development] There's also a separate documentation page which can be found [here](FarmMapsLibs.md). [under development]

2
Running-tasks.md
View File

@ -259,7 +259,7 @@ Vary: Accept-Encoding
## What's next? ## 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. 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](/wiki/Home#task-examples) Head over to the [Task Examples](README.md#task-examples)

2
Upload-a-file.md
View File

@ -9,7 +9,7 @@ The workflow for uploading a file is as follows:
* Downloading the file to check (optional) * Downloading the file to check (optional)
**Prerequisites** **Prerequisites**
- To be able to perform requests, make sure you have an [access token](/wiki/Create-access-token). - To be able to perform requests, make sure you have an [access token](Create-access-token.md).
### Registering the upload ### Registering the upload
Before a file can be uploaded it needs to be registered. Files smaller than 2 MB can be uploaded in one chunk. Before a file can be uploaded it needs to be registered. Files smaller than 2 MB can be uploaded in one chunk.

12
VRAHerbicide-API.md
View File

@ -1,5 +1,5 @@
## VRAHerbicide API ## VRAHerbicide API
[<< Home](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Home) [<< Home](README.md)
FarmMaps is an asynchronous architecture, the API flow keeps this in mind. 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 (frontend). The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow (frontend).
@ -12,7 +12,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
**Users can poll the task api to see if a task is completed** **Users can poll the task api to see if a task is completed**
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.** **This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
[Poll task status](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Polling-task-status) [Poll task status](Polling-task-status.md)
**Users can query the API for child items of a cropfield to see what items it has.** **Users can query the API for child items of a cropfield to see what items it has.**
@ -30,11 +30,11 @@ For the currently available public FarmMaps API you can take a look at swagger:
* Download item data (tiff of shape) * Download item data (tiff of shape)
### Steps ### Steps
[Authentication](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) [Authentication](Authentication.md)
##### Optional ##### Optional
[Create Cropfield](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Cropfield) [Create Cropfield](Create-Cropfield.md)
[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) [Upload Data](Upload-Data.md)
###### Transform shape to geotiff ###### Transform shape to geotiff
The VRAHerbicide task only processes tiff items as input. The VRAHerbicide task only processes tiff items as input.
@ -163,7 +163,7 @@ Response 403 No WRITE permissions in item
Response 404 Item not found Response 404 Item not found
##### Create taskmap ##### Create taskmap
[Create Taskmap](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) [Create Taskmap](Create-Taskmap.md)
##### Download the data ##### Download the data
In case the data is available it can be downloaded with the File API. In case the data is available it can be downloaded with the File API.

12
VRANbs-API.md
View File

@ -1,5 +1,5 @@
## VRANbs API v0.2 ## VRANbs API v0.2
[<< Home](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Home) [<< Home](README.md)
FarmMaps is an asynchronous architecture, the API flow keeps this in mind. 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 (frontend). The API expects that all data is already processed and available provided, for example through the normal FarmMaps flow (frontend).
@ -17,7 +17,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
**Users can poll the task api to see if a task is completed** **Users can poll the task api to see if a task is completed**
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.** **This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
[Poll task status](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Polling-task-status) [Poll task status](Polling-task-status.md)
**Users can query the API for child items of a cropfield to see what items it has.** **Users can query the API for child items of a cropfield to see what items it has.**
@ -38,11 +38,11 @@ For the currently available public FarmMaps API you can take a look at swagger:
* Download item data (tiff of shape) * Download item data (tiff of shape)
### Steps ### Steps
[Authentication](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) [Authentication](Authentication.md)
##### Optional ##### Optional
[Create Cropfield](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Cropfield) [Create Cropfield](Create-Cropfield.md)
[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) [Upload Data](Upload-Data.md)
###### Transform shape to geotiff ###### Transform shape to geotiff
The VRANbs task only processes tiff items as input. The VRANbs task only processes tiff items as input.
@ -286,7 +286,7 @@ Response 403 No WRITE permissions in item
Response 404 Item not found Response 404 Item not found
##### Create taskmap ##### Create taskmap
[Create Taskmap](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) [Create Taskmap](Create-Taskmap.md)
##### Download the data ##### Download the data
In case the data is available it can be downloaded with the File API. In case the data is available it can be downloaded with the File API.

14
VRAPoten-API.md
View File

@ -1,8 +1,8 @@
## VRAPoten API v0.1.1 ## VRAPoten API v0.1.1
[<< Home](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Home) [<< Home](README.md)
FarmMaps is an asynchronous architecture, the API flow keeps this in mind. 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 For the currently available public FarmMaps API you can take a look at swagger: http://farmmaps.awtest.nl/swagger/index.html
@ -14,7 +14,7 @@ For the currently available public FarmMaps API you can take a look at swagger:
**Users can poll the task api to see if a task is completed** **Users can poll the task api to see if a task is completed**
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.** **This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
[Poll task status](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Polling-task-status) [Poll task status](Polling-task-status.md)
### API flow ### API flow
* Authenticate User * Authenticate User
@ -30,13 +30,13 @@ For the currently available public FarmMaps API you can take a look at swagger:
### Steps ### Steps
###### Authentication ###### Authentication
[Authentication](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) [Authentication](Authentication.md)
###### Create cropfield with FarmMaps API (optional) ###### Create cropfield with FarmMaps API (optional)
[Create Cropfield](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Cropfield) [Create Cropfield](Create-Cropfield.md)
###### Uploading own data (optional) ###### Uploading own data (optional)
[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) [Upload Data](Upload-Data.md)
###### Creating appliance maps ###### Creating appliance maps
Execute the VRAPotenTask with the item code of the cropfield as parameter inside {code}. Execute the VRAPotenTask with the item code of the cropfield as parameter inside {code}.
@ -75,7 +75,7 @@ Response 403 No WRITE permissions in item
Response 404 Item not found Response 404 Item not found
###### Create taskmap ###### Create taskmap
[Create Taskmap](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) [Create Taskmap](Create-Taskmap.md)
###### Download the data ###### Download the data
In case the data is available it can be downloaded with the File API. In case the data is available it can be downloaded with the File API.