Document mc-server endpoints

SJSURoboticsTeam / urc-central-2021

Track progress and information for the URC 2021 competition

MIT License

1 stars 0 forks source link

Closed naterpotatoers closed 2 years ago

naterpotatoers commented 3 years ago

Ideally we should use swagger REST API documentation tool that way anyone who plans on using the mc-server will be greeted w/ api info at root page

naterpotatoers commented 3 years ago

Currently exists the following: / GET *Swagger page should be here ideally

/drive GET POST /drive/status GET

/arm GET POST /arm/status GET

naterpotatoers commented 2 years ago

This needs to be done for /arm now that that endpoint is built out

acarrou commented 2 years ago

Server Arm endpoint is finished until further notice.

naterpotatoers commented 2 years ago

this is referring to the swagger page found here https://github.com/SJSURoboticsTeam/urc-mc_server-2021/blob/master/swagger.json I'm not sure if it still works anymore to be honest...