/

  • redirect to man page
get

/man

  • contains manual information
  • raml have not specification to describe media type of response for different than main media type. so media type must be application/html, application/image or anything else, not only application/json
get

/oauth

  • allow authenticate using oauth-2
  • allow create account by google oauth-2
get
get
  • this is not real resource
  • this is endpoint which oauth provider call to transfer code after authenticate successful
get
  • exchange refresh_token to get new access_token
  • refresh_token store at server, and it identity by access_token in requests header, authorization field

/me

  • retrieve, update information of current login user
get
put
  • update current using of scheduler
  • after that, service will add scheduler to collection scheduler of account in schedulers field
delete
  • remove scheduler from collection of schedulers of account
put

/region

  • region was initialized during installation of service
  • region contains information of regions in the world follow iso-639-2
  • region is read-only resource
get
get

/scheduler

  • scheduler contains meta data to initialize scheduler in client
  • must login to create scheduler. user which identity will be own scheduler was created
  • any body can get any scheduler
  • only owner can put, patch, delete scheduler
get
post
  • must not specify id field. it will be generate by service
  • must not specify author. it will be fill by service after authenticate
get
put
  • must not specify id
  • must not specify author
patch
  • must not specify id
  • must not specify author
delete