REST Actions
REST API actions | name | type | action | request | URL | response | notes |
|---|---|---|---|---|---|---|
| Welcome | POST | Returns a random welcome message | {"request": "welcome"} | / | {"code": , "message": <random_welcome_message>}
|
Basic request |
| Help | POST | Returns a message to help user to use this API | {"request": "help"} or {} | / | {"code": , "message": <help_generic_message>, "help": {<REST_command_name>: {"name": <REST_command_name>, "type": <GET_or_POST>, "action": , "request": <request_structure>, "URL": <REST_URL>, "response": <response_structure>, "notes": }, ...}}
|
Gives to the user all the information to use this REST API |
| Auth | POST | Check if account is it ok | {"request": "login", "payload": {"username": <GitHub_username>, "token": <Github_token>}} | / | {"code": , "message": <ok_or_error_message>, "sub_info": {"name": <sub_name>, "active": <true/false>, "super": <true/false>, "max": {"day": <max_usages_for_day>, "h": <max_usages_for_hour>, "m": <max_usages_for_minute>}, "remaining": {"day": <remaining_usages_for_day>, "h": <remaining_usages_for_hour>, "m": <remaining_usages_for_minute>}}}
|
This is userfull to get any usefull info about a consumer |
| Create Repository | POST | Permits user to create a repository | {"request": "create_repo", payload: {"token": <GitHub_token>, "username": <GitHub_username>, "answers": { "name": <New_repo_name> [, "template": <Template_to_use(eg. default or Owner/repo-template)>] [, "descr": ] [, "prefix": <The_prefix_of_the_repo(if you want once)>] [, "private": <true/false>] [, "isOrg": <If_you_want_your_repo_in_an_organization(true/false)> , "org": <Name_of_the_org_if_isOrg_true> [, "team": <The_name_of_the_team_if_isOrg_true>] ]}}} | / | {"code": , "message": <response_message>}
|
This REST API call permits to the consumer to ask to createstructure"s service to create a repository |
| Create Server | POST | Permits to add a server to valid ones | {"request": "create_server", payload: {"token": <GitHub_token>, "username": <GitHub_username>, "server_name": <server_name>, "server_password": <server_password>, "server_description": <server_description>, "server_public_key": <server_public_key>} | / | {"code": , "message": <response_message>}
|
This REST API call permits to add a server to valid ones, so it can start to contribute to the project |
| Reserve a new repo to create (server-side) | POST | functionality | {"request": "server_reserve_job", "server_name": <server_name>, "server_password": <server_password>} | / | {"code": , "message": <response_message>, "repoID": }
|
Usefull for the server to reserve a repo to create it |
| Get a new repo info to create it (server-side) | POST | functionality | {"request": "server_get_job_info", "server_name": <server_name>, "server_password": <server_password>, "repoID": } | / | {"code": , "message": <response_message>, "repo_info": <repo_info>}
|
Usefull for the server to ask a repo info to create it |
| Set a repo job as done (server-side) | POST | functionality | {"request": "server_set_job_done", "server_name": <server_name>, "server_password": <server_password>, "repoID": } | / | {"code": , "message": <response_message>}
|
Usefull for the server to set repo job as done |
| Set a new server priority (server-side) | POST | functionality | {"request": "server_set_priority", "username": <GitHub_username>, "token": <Github_token>, "server_name": <server_name>, "server_priority": <server_priority>} | / | {"code": , "message": <response_message>}
|
Ask to do some commands to a server without ssh |
| Get a priority if there was one (server-side) | POST | functionality | {"request": "server_get_priority", "server_name": <server_name>, "server_password": <server_password>} | / | {"code": , "message": <response_message> [, "priority_instruction": <priority_instruction>, "priorityID": ]}
|
Usefull for the server to get the priority |
| Set a repo job as done (server-side) | POST | functionality | {"request": "server_set_priority_done", "server_name": <server_name>, "server_password": <server_password>, "priorityID": } | / | {"code": , "message": <response_message>}
|
Usefull to set priority as done |