cyber-dojo-retired / porter

repo for the cyberdojo/porter Docker image

Home Page:https://cyber-dojo.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CircleCI

cyber-dojo yin/yang logo

cyberdojo/porter docker image

API:

  • All methods receive their named arguments in a json hash.
  • All methods return a json hash with a single key.
    • If the method completes, the key equals the method's name.
    • If the method raises an exception, the key equals "exception".

GET ready()

  • parameters, none
  {}
  • returns true if the service is ready, otherwise false.
  { "ready": "true" }

GET sha()

Returns the git commit sha used to create the cyberdojo/porter docker image.

  • parameters, none
  {}
  • returns the sha, eg
  { "sha": "8210a96a964d462aa396464814d9e82cad99badd" }

GET ported?(id6)

Asks if id6 matches the first 6 digits of any already ported storer session's 10-digit id.

  • parameter, a 6-digit id, eg
    { "id6": "55D3B9" }
  • returns, true if it does, false if it doesn't.
  { "ported": true }
  { "ported": false }

GET ported_id(partial_id)

Asks for the 6-digit saver id (if it exists) of the already ported storer session whose 10-digit id uniquely completes the given 6-10 digit partial_id.

  • parameter, a 6-10 digit storer session id, eg
    { "partial_id": "55D3B9" }
    { "partial_id": "55D3B97" }
    { "partial_id": "55D3B97E" }    
  • returns the 6-digit saver id if it exists, otherwise the empty string.
    { "ported_id": "55D3B9" }
    { "ported_id": "E5pL3S" }
    { "ported_id": "" }

cyber-dojo.org home page

About

repo for the cyberdojo/porter Docker image

https://cyber-dojo.org


Languages

Language:Shell 56.6%Language:Ruby 42.9%Language:Dockerfile 0.4%