diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..62c8935 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ \ No newline at end of file diff --git a/Home.md b/Home.md index 1b2fb09..54688ec 100644 --- a/Home.md +++ b/Home.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](/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 @@ -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](/wiki/Integrating-FarmMaps-OIDC) -- [Creating an access token for testing.](/wiki/Create-access-token) +- [Integrating FarmMaps Open ID Connect into your application](Integrating-FarmMaps-OIDC.md) +- [Creating an access token for testing.](Create-access-token.md) ## 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](/wiki/Upload-a-file) -* [Creating a cropfield](/wiki/Create-a-cropfield) -* [Running a task](/wiki/Running-tasks) +* [Uploading a file](Upload-a-file.md) +* [Creating a cropfield](Create-a-cropfield.md) +* [Running a task](Running-tasks.md) 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. ### Task examples -* [VRAPoten-API](/wiki/VRAPoten-API) -* [VRANbs-API](/wiki/VRANbs-API) -* [VRAHerbicide-API](/wiki/VRAHerbicide-API) +* [VRAPoten-API](VRAPoten-API.md) +* [VRANbs-API](VRANbs-API.md) +* [VRAHerbicide-API](VRAHerbicide-API.md) diff --git a/Main-components.md b/Main-components.md index 5f2a147..506eace 100644 --- a/Main-components.md +++ b/Main-components.md @@ -73,14 +73,14 @@ There's also swagger based reference of the [REST API](https://farmmaps.awacc.nl #### 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](/wiki/Message-Queue-Endpoint). +As a reference, please also see [Sending data to MQTT](Message-Queue-Endpoint.md). ### 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](/wiki/Workflow) +How this works is described in [the workflow article](Workflow.md) ### 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](/wiki/FarmMapsLibs). [under development] +There's also a separate documentation page which can be found [here](FarmMapsLibs.md). [under development] diff --git a/Running-tasks.md b/Running-tasks.md index 0d1ea02..0be5121 100644 --- a/Running-tasks.md +++ b/Running-tasks.md @@ -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](/wiki/Home#task-examples) +Head over to the [Task Examples](README.md#task-examples) diff --git a/Upload-a-file.md b/Upload-a-file.md index 36ed9e7..c17fdec 100644 --- a/Upload-a-file.md +++ b/Upload-a-file.md @@ -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](/wiki/Create-access-token). +- To be able to perform requests, make sure you have an [access token](Create-access-token.md). ### 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. diff --git a/VRAHerbicide-API.md b/VRAHerbicide-API.md index 55687e6..e0b4724 100644 --- a/VRAHerbicide-API.md +++ b/VRAHerbicide-API.md @@ -1,5 +1,5 @@ ## 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. 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](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.** @@ -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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) +[Authentication](Authentication.md) ##### Optional -[Create Cropfield](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Cropfield) -[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) +[Create Cropfield](Create-Cropfield.md) +[Upload Data](Upload-Data.md) ###### 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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) +[Create Taskmap](Create-Taskmap.md) ##### Download the data In case the data is available it can be downloaded with the File API. diff --git a/VRANbs-API.md b/VRANbs-API.md index fa4c2d8..ac9ef00 100644 --- a/VRANbs-API.md +++ b/VRANbs-API.md @@ -1,5 +1,5 @@ ## 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. 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](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.** @@ -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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) +[Authentication](Authentication.md) ##### Optional -[Create Cropfield](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Cropfield) -[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) +[Create Cropfield](Create-Cropfield.md) +[Upload Data](Upload-Data.md) ###### 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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) +[Create Taskmap](Create-Taskmap.md) ##### Download the data In case the data is available it can be downloaded with the File API. diff --git a/VRAPoten-API.md b/VRAPoten-API.md index aca10e5..ad6fcbf 100644 --- a/VRAPoten-API.md +++ b/VRAPoten-API.md @@ -1,8 +1,8 @@ ## 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. -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 @@ -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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Polling-task-status) +[Poll task status](Polling-task-status.md) ### 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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Authentication) +[Authentication](Authentication.md) ###### 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) -[Upload Data](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Upload-Data) +[Upload Data](Upload-Data.md) ###### 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](https://git.akkerweb.nl/FarmMaps/Documentatie/wiki/Create-Taskmap) +[Create Taskmap](Create-Taskmap.md) ###### Download the data In case the data is available it can be downloaded with the File API.