From 62b8aebb4480ae97338ca2ef4c6e8957f3e0114a Mon Sep 17 00:00:00 2001 From: Tor-Einar Skog <tor-einar.skog@nibio.no> Date: Wed, 1 Mar 2023 12:59:34 +0100 Subject: [PATCH] Docs update --- docs/create_client.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/create_client.md b/docs/create_client.md index 573d176..f94e964 100644 --- a/docs/create_client.md +++ b/docs/create_client.md @@ -2,25 +2,28 @@ Running a model is a matter of creating a client that is able to send a POST request to a common endpoint, and provide Json in the request body and consume the standard Json that is returned from the model. -The endpoint for running a model is: +The **endpoint for running a model** is: ``` {{vipslogic_url}}/models/{{MODEL_ID}}/run ``` -Get the model ID by simply connecting to +**Get the model ID** by simply connecting to ``` {{vipslogic_url}}/models/ ``` -So you must create a model configuration object and pass it in the request body. Each model has its own set of input data. To se a configuration example for a specific model, query +So you must create a model configuration object and pass it in the request body. Each model has its own set of input data. +To see a **configuration example for a specific model**, query ``` {{vipslogic_url}}/models/{{MODEL_ID}}/sampleconfig ``` Here's a sample for the Carrot rust fly temperature model (PSILARTEMP) +**NOTE: Not all models are properly documented. If you find models with missing information, get in touch and we'll +help you out** ``` { @@ -47,7 +50,7 @@ The `"loginInfo"` property is only relevant when running the model through the V An explanation of the input parameters should be provided for each model from this endpoint: ``` -{{vipslogic_url}}/models/{{MODEL_ID}}/sampleconfig +{{vipslogic_url}}/models/{{MODEL_ID}}/usage ``` If not, please contact the model provider and notify them. -- GitLab