Skip to content

Commit bac3d94

Browse files
authored
Update README
Remove the disclaimer about API and add a warning instead; Add a note for developer
1 parent 2709762 commit bac3d94

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ $ planimation.py submitPDDL [path of domain] [path of problem] [path of animatio
3333
$ planimation.py submitVFG [path of VFG] [output format]
3434
```
3535

36-
### Disclaimer
37-
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).
36+
### Note for developer
37+
The urls in `planimation_api.py` need to be changed to the actual urls in use.
38+
https://github.com/changyuanl/planimation-pythonAPI/blob/2709762ccd9eacf9955fbd1abab1d22419704033/planimation_api.py#L6-L8
39+
40+
### Warning
41+
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.
3842

3943
### Thanks
4044
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.

0 commit comments

Comments
 (0)