Add API for creating test result via global data store

apis/datastore.json

@@ -0,0 +1,94 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "description": "A service that orchestrates the Sauce cloud as well as test runner packages.",
+    "version": "0.1.7",
+    "title": "Testrunner Data Store Job Orchestrator",
+    "termsOfService": "https://saucelabs.com/terms-of-service",
+    "contact": {
+      "name": "Open Source Program Office at Sauce",
+      "email": "[email protected]",
+      "url": "https://saucelabs.com"
+    }
+  },
+  "externalDocs": {
+    "description": "Sauce Labs Wiki",
+    "url": "https://wiki.saucelabs.com"
+  },
+  "basePath": "/v1/test-results",
+  "servers": [
+    {
+      "url": "https://api.{region}.saucelabs.{tld}",
+      "variables": {
+        "region": {
+          "default": "us-west-1",
+          "description": "region of datacenter",
+          "enum": [
+            "us-west-1",
+            "eu-central-1",
+            "staging"
+          ]
+        },
+        "tld": {
+          "default": "com",
+          "description": "internal or external API",
+          "enum": [
+            "net",
+            "com"
+          ]
+        }
+      }
+    }
+  ],
+  "components": {
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      },
+      "basicAuth": {
+        "type": "http",
+        "scheme": "basic"
+      }
+    }
+  },
+  "paths": {
+    "/": {
+      "post": {
+        "description": "create test result job via data store",
+        "operationId": "createResultJob",
+        "parameters": [
+          {
+            "in": "body",
+            "name": "parameters",
+            "required": true,
+            "description": "create test result job request body",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "externalDocs": {
+          "description": "TBD",
+          "url": "https://wiki.saucelabs.com"
+        },
+        "tags": [
+          "Job"
+        ],
+        "responses": {
+          "200": {
+            "description": "create test result job",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "json"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

src/cli.js

@@ -36,8 +36,8 @@ export const run = () => {
                 yargs.positional(param.name, paramDescription)
             }
         }, async (argv) => {
-            const { user, key, headless, region, proxy } = Object.assign({}, DEFAULT_OPTIONS, argv)
-            const api = new SauceLabs({ user, key, headless, region, proxy })
+            const { user, key, headless, region, proxy, tld } = Object.assign({}, DEFAULT_OPTIONS, argv)
+            const api = new SauceLabs({ user, key, headless, region, proxy, tld })
             const requiredParams = params.filter((p) => p.required).map((p) => argv[p.name])
 
             try {

src/constants.js

@@ -18,7 +18,8 @@ const protocols = [
     require('../apis/sauce.json'),
     require('../apis/rdc.json'),
     require('../apis/performance.json'),
-    require('../apis/testrunner.json')
+    require('../apis/testrunner.json'),
+    require('../apis/datastore.json')
 ]
 
 const protocolFlattened = new Map()
@@ -31,7 +32,6 @@ for (const { paths, parameters, basePath, servers } of protocols) {
     for (const [endpoint, methods] of Object.entries(paths)) {
         for (const [method, description] of Object.entries(methods)) {
             let commandName = camelCase(description.operationId)
-
             /**
              * mark commands as depcrecated in the command names
              */