Slightly updated instructions for the API

Rafael
Rafael M. Martins 7 months ago
parent 6cd615fb94
commit 0921e8a763
  1. 27
      py/README.md

@ -147,7 +147,7 @@ Returns data formatted for the 'yearly' horizon view.
## Saved Flexiboards
### /boards
### /boards/Hus_ID
A short summary of all the boards that are saved.
@ -155,8 +155,9 @@ A short summary of all the boards that are saved.
{
Board_ID [int],
Name [String],
Description [String]
}
Description [String],
URL [String] // https://localhost:8000/h=Hus&b=Board_ID
}
]
### /boards/save
@ -164,12 +165,13 @@ A short summary of all the boards that are saved.
Method: POST
Every time we call save, it creates a new board.
**ID is auto generated.**
**ID is auto generated.** // nome -> lowercase -> replace special characters to -
**Name must be unique.**
{
Name [String],
Description [String],
Hus [String],
col-left: [
{
order [int],
@ -181,8 +183,12 @@ Every time we call save, it creates a new board.
...
}
],
col-center: [ ... ], // same as above
col-right: [ ... ] // same as above
col-center: [
...
], // same as above
col-right: [
...
] // same as above
}
### /boards/[Board_ID]
@ -193,6 +199,7 @@ Loads all the detailed information for the board with Board_ID.
Board_ID [int],
Name [String],
Description [String],
Hus [String],
col-left: [
{
order [int],
@ -204,6 +211,10 @@ Loads all the detailed information for the board with Board_ID.
...
}
],
col-center: [ ... ], // same as above
col-right: [ ... ] // same as above
col-center: [
...
], // same as above
col-right: [
...
] // same as above
}

Loading…
Cancel
Save