From bac3d948ffb7f0ceb6de389bf8f7dc38e57328be Mon Sep 17 00:00:00 2001 From: xinzhel97 <62744067+xinzhel97@users.noreply.github.com> Date: Fri, 6 Nov 2020 22:03:09 +1100 Subject: [PATCH] Update README Remove the disclaimer about API and add a warning instead; Add a note for developer --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 76f580b..60ba030 100755 --- a/README.md +++ b/README.md @@ -33,8 +33,12 @@ $ planimation.py submitPDDL [path of domain] [path of problem] [path of animatio $ planimation.py submitVFG [path of VFG] [output format] ``` -### Disclaimer -The API should be considered to be in a very alpha phase at the moment. It's not expected to handle heavy traffic and the error messages may not be complete. Until this disclaimer is removed, we **DO NOT RECOMMEND** using the API for official business (academic or otherwise). +### Note for developer +The urls in `planimation_api.py` need to be changed to the actual urls in use. +https://github.com/changyuanl/planimation-pythonAPI/blob/2709762ccd9eacf9955fbd1abab1d22419704033/planimation_api.py#L6-L8 + +### Warning +A malicious or careless user can easily spam requests using the python library and there is no mechanism at the server to handle such situation. Until relevant mechanism is implemented, it may not be safe to publish this python library. ### Thanks The first version of Planimation API is developed by Changyuan Liu, Lingfeng Qiang, Mengyi Fan, Xinzhe Li and Zhaoqi Fang under Nir Lipovetzky's guidance.