fix url
This commit is contained in:
Mark van der Wal
parent
da2f42ee74
commit
3894b4d6e2
@ -67,20 +67,20 @@ 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][/src/branch/master/examples/]
|
||||
Several how-to's can be found in the [examples folder][src/branch/master/examples/]
|
||||
There's also swagger based reference of the [REST API](https://farmmaps.awacc.nl/swagger/index.html)
|
||||
|
||||
#### 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.
|
||||
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](/src/branch/master/Message-Queue-Endpoint).
|
||||
As a reference, please also see [Sending data to MQTT](src/branch/master/Message-Queue-Endpoint).
|
||||
|
||||
### 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.
|
||||
How this works is described in [the workflow article](/src/branch/master/Workflow)
|
||||
How this works is described in [the workflow article](src/branch/master/Workflow)
|
||||
|
||||
### 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).
|
||||
There's also a separate documentation page which can be found [here](/src/branch/master/FarmMapsLibs). [under development]
|
||||
There's also a separate documentation page which can be found [here](src/branch/master/FarmMapsLibs). [under development]
|
||||
|
||||
|
||||
18
README.md
18
README.md
@ -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](/src/branch/master/Workflow) and [FarmMaps Main Components](/src/branch/master/Main-components) pages.
|
||||
The workflow and high-level architecture FarmMaps are documented on the [Farmmaps Workflow](src/branch/master/Workflow) and [FarmMaps Main Components](src/branch/master/Main-components) pages.
|
||||
|
||||
### 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:
|
||||
|
||||
- [Integrating FarmMaps Open ID Connect into your application](/src/branch/master/Integrating-FarmMaps-OIDC)
|
||||
- [Creating an access token for testing.](/src/branch/master/Create-access-token)
|
||||
- [Integrating FarmMaps Open ID Connect into your application](src/branch/master/Integrating-FarmMaps-OIDC)
|
||||
- [Creating an access token for testing.](src/branch/master/Create-access-token)
|
||||
|
||||
## Using the FarmMaps 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.
|
||||
|
||||
We provide the following guides:
|
||||
* [Uploading a file](/src/branch/master/Upload-a-file)
|
||||
* [Creating a cropfield](/src/branch/master/Create-a-cropfield)
|
||||
* [Running a task](/src/branch/master/Running-tasks)
|
||||
* [Uploading a file](src/branch/master/Upload-a-file)
|
||||
* [Creating a cropfield](src/branch/master/Create-a-cropfield)
|
||||
* [Running a task](src/branch/master/Running-tasks)
|
||||
|
||||
Generally, tasks can be run in the same way.
|
||||
However, each specific task has it's own inputs and properties.
|
||||
How these work can be found in the use task examples below.
|
||||
|
||||
### <a name="task-examples"></a>Task examples
|
||||
* [VRAPoten-API](/src/branch/master/VRAPoten-API)
|
||||
* [VRANbs-API](/src/branch/master/VRANbs-API)
|
||||
* [VRAHerbicide-API](/src/branch/master/VRAHerbicide-API)
|
||||
* [VRAPoten-API](src/branch/master/VRAPoten-API)
|
||||
* [VRANbs-API](src/branch/master/VRANbs-API)
|
||||
* [VRAHerbicide-API](src/branch/master/VRAHerbicide-API)
|
||||
|
||||
|
||||
|
||||
@ -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](/src/branch/master/Home#task-examples)
|
||||
Head over to the [Task Examples](src/branch/master/Home#task-examples)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ The workflow for uploading a file is as follows:
|
||||
* Downloading the file to check (optional)
|
||||
|
||||
**Prerequisites**
|
||||
- To be able to perform requests, make sure you have an [access token](/src/branch/master/Create-access-token).
|
||||
- To be able to perform requests, make sure you have an [access token](src/branch/master/Create-access-token).
|
||||
|
||||
### 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.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
## VRAHerbicide API
|
||||
[<< Home](/src/branch/master/Home)
|
||||
[<< Home](src/branch/master/Home)
|
||||
|
||||
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).
|
||||
@ -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**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](/src/branch/master/Polling-task-status)
|
||||
[Poll task status](src/branch/master/Polling-task-status)
|
||||
|
||||
**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)
|
||||
|
||||
### Steps
|
||||
[Authentication](/src/branch/master/Authentication)
|
||||
[Authentication](src/branch/master/Authentication)
|
||||
|
||||
##### Optional
|
||||
[Create Cropfield](/src/branch/master/Create-Cropfield)
|
||||
[Upload Data](/src/branch/master/Upload-Data)
|
||||
[Create Cropfield](src/branch/master/Create-Cropfield)
|
||||
[Upload Data](src/branch/master/Upload-Data)
|
||||
|
||||
###### Transform shape to geotiff
|
||||
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
|
||||
|
||||
##### Create taskmap
|
||||
[Create Taskmap](/src/branch/master/Create-Taskmap)
|
||||
[Create Taskmap](src/branch/master/Create-Taskmap)
|
||||
|
||||
##### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
## VRANbs API v0.2
|
||||
[<< Home](/src/branch/master/Home)
|
||||
[<< Home](src/branch/master/Home)
|
||||
|
||||
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).
|
||||
@ -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**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](/src/branch/master/Polling-task-status)
|
||||
[Poll task status](src/branch/master/Polling-task-status)
|
||||
|
||||
**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)
|
||||
|
||||
### Steps
|
||||
[Authentication](/src/branch/master/Authentication)
|
||||
[Authentication](src/branch/master/Authentication)
|
||||
|
||||
##### Optional
|
||||
[Create Cropfield](/src/branch/master/Create-Cropfield)
|
||||
[Upload Data](/src/branch/master/Upload-Data)
|
||||
[Create Cropfield](src/branch/master/Create-Cropfield)
|
||||
[Upload Data](src/branch/master/Upload-Data)
|
||||
|
||||
###### Transform shape to geotiff
|
||||
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
|
||||
|
||||
##### Create taskmap
|
||||
[Create Taskmap](/src/branch/master/Create-Taskmap)
|
||||
[Create Taskmap](src/branch/master/Create-Taskmap)
|
||||
|
||||
##### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
## VRAPoten API v0.1.1
|
||||
[<< Home](/src/branch/master/Home)
|
||||
[<< Home](src/branch/master/Home)
|
||||
|
||||
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.
|
||||
@ -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**
|
||||
**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.**
|
||||
[Poll task status](/src/branch/master/Polling-task-status)
|
||||
[Poll task status](src/branch/master/Polling-task-status)
|
||||
|
||||
### API flow
|
||||
* Authenticate User
|
||||
@ -30,13 +30,13 @@ For the currently available public FarmMaps API you can take a look at swagger:
|
||||
|
||||
### Steps
|
||||
###### Authentication
|
||||
[Authentication](/src/branch/master/Authentication)
|
||||
[Authentication](src/branch/master/Authentication)
|
||||
|
||||
###### Create cropfield with FarmMaps API (optional)
|
||||
[Create Cropfield](/src/branch/master/Create-Cropfield)
|
||||
[Create Cropfield](src/branch/master/Create-Cropfield)
|
||||
|
||||
###### Uploading own data (optional)
|
||||
[Upload Data](/src/branch/master/Upload-Data)
|
||||
[Upload Data](src/branch/master/Upload-Data)
|
||||
|
||||
###### Creating appliance maps
|
||||
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
|
||||
|
||||
###### Create taskmap
|
||||
[Create Taskmap](/src/branch/master/Create-Taskmap)
|
||||
[Create Taskmap](src/branch/master/Create-Taskmap)
|
||||
|
||||
###### Download the data
|
||||
In case the data is available it can be downloaded with the File API.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user