api.md

JSON in, JSON out

• All API calls receive a JSON hash.
  • The hash contains any arguments as key-value pairs.
• All API calls return a JSON hash.
  • If the call completes, a key equals the call name.
  • If the call raises an exception, a key equals "exception".

---

GET alive()

• returns
  • true (useful as a liveness probe)
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/alive

  { "alive?": true }

---

GET ready()

• returns
  • true if the service is ready
  • false if the service is not ready
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/ready

  { "ready?": true }

---

GET sha()

• returns
  • The 40 character git commit sha used to create the docker image.
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/sha

  { "sha": "76dd1cabf82aa624a1dabe194731b3cd18aae36a" }

---

GET names()

• returns
  • The display_name's from all manifests.
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/names | jq .

  {
    "names": [
      "C#, NUnit",
      "C++ (g++), GoogleMock",
      "Java 21, JUnit 5"
    ]
  }

---

GET manifests()

• returns
  • All the start-point manifests.
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/manifests | jq .

  {
    "manifests": {
      "C#, NUnit": {
        "image_name": "cyberdojofoundation/csharp_nunit:1452bb7",
        "display_name": "C#, NUnit",
        "filename_extension": [".cs"],
        "max_seconds": 10,
        "tab_size": 4,
        "visible_files": {}
      },
      "C++ (g++), GoogleMock": {
        "image_name": "cyberdojofoundation/gpp_googlemock:129f26f",
        "display_name": "C++ (g++), GoogleMock",
        "filename_extension": [".cpp", ".hpp", ".c", ".h"],
        "max_seconds": 15,
        "tab_size": 4,
        "visible_files": {}
      },
      "Java 21, JUnit 5": {
        "image_name": "cyberdojofoundation/java_junit:edf2565",
        "display_name": "Java 21, JUnit 5",
        "filename_extension": [".java"],
        "max_seconds": 10,
        "tab_size": 4,
        "progress_regexs": [
          "Failures (\\d)\\:",
          "^\\[\\s+(\\d+) tests successful\\s+\\]"
        ],
        "visible_files": {}
      }
    }
  }

---

GET manifest(name)

• returns
  • The manifest for the given name.
• parameters
  • name:String from a previous call to the names method above
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -d '{"name":"C#, NUnit"}' -X GET 0.0.0.0:80/manifest | jq .

  { "manifest": {
        "display_name": "C#, NUNit",
        "image_name": "cyberdojofoundation/csharp_nunit:1452bb7",
        "filename_extension": [ ".cs" ],
        "visible_files": {
          "Hiker.cs": {               
            "content": "public class Hiker..."
          },
          "HikerTest.cs": {
            "content": "using NUnit.Framework;..."
          },
          "cyber-dojo.sh": {
            "content": "NUNIT_PATH=/nunit/lib/net45..."
          }
        }
      }
    }

---

GET image_names()

• returns
  • The image_names from all manifests.
• parameters
  • none
• example

  docker run --detach -p 80:4524 acme/my-languages-start-points:f7d51d0
  curl -X GET 0.0.0.0:80/image_names | jq .

    { "image_names": [
        "cyberdojofoundation/csharp_nunit:1452bb7",
        "cyberdojofoundation/python_unittest:51c7d93",
        "cyberdojofoundation/ruby_mini_test:a074c0a"
      ]
    }